Add argument to set column name

This allows the user to specify a custom column name, instead of the
default being hard-coded to the symbol + .div or .spl.

Fixes #369.

Author: joshuaulrich

R/getDividends.R

@@ -1,6 +1,7 @@
 `getDividends` <-
 function(Symbol,from='1970-01-01',to=Sys.Date(),env=parent.frame(),src='yahoo',
          auto.assign=FALSE,auto.update=FALSE,verbose=FALSE,split.adjust=TRUE,...,
+         colname=NULL,
          curl.options=list()) {
 
   tmp.symbol <- Symbol
@@ -59,7 +60,11 @@ function(Symbol,from='1970-01-01',to=Sys.Date(),env=parent.frame(),src='yahoo',
     }
 
     fr <- divs
-    colnames(fr) <- paste(Symbol.name,'div',sep='.')
+    if(is.null(colname)) {
+      colnames(fr) <- paste(Symbol.name,'div',sep='.')
+    } else {
+      colnames(fr) <- colname
+    }
   } else {
     fr <- xts(numeric(0), .Date(integer(0)))
   }

R/getSplits.R

@@ -1,6 +1,6 @@
 `getSplits` <-
 function(Symbol,from='1970-01-01',to=Sys.Date(),env=parent.frame(),src='yahoo',
-         auto.assign=FALSE,auto.update=FALSE,verbose=FALSE,...,
+         auto.assign=FALSE,auto.update=FALSE,verbose=FALSE,...,colname=NULL,
          curl.options=list()) {
 
   # Function written by Joshua Ulrich, using
@@ -47,7 +47,11 @@ function(Symbol,from='1970-01-01',to=Sys.Date(),env=parent.frame(),src='yahoo',
       xts(ratio, as.Date(.POSIXct(x$date, "UTC")))
     }
     fr <- 1 / do.call(rbind, lapply(split.events, to.xts))
-    colnames(fr) <- paste(Symbol.name,'spl',sep='.')
+    if(is.null(colname)) {
+      colnames(fr) <- paste(Symbol.name,'spl',sep='.')
+    } else {
+      colnames(fr) <- colname
+    }
   } else {
     fr <- xts(numeric(0), .Date(integer(0)))
   }

man/getDividends.Rd

@@ -16,6 +16,7 @@ getDividends(Symbol,
              verbose = FALSE,
              split.adjust = TRUE,
              ...,
+             colname=NULL,
              curl.options = list())
 }
 %- maybe also 'usage' for other objects documented here.
@@ -31,6 +32,7 @@ getDividends(Symbol,
   \item{split.adjust}{ adjust dividends for splits (\code{TRUE} by default
     because that's what Yahoo returns)}
   \item{\dots}{ currently unused }
+  \item{colname}{ name for the column of data }
   \item{curl.options}{ options passed to \code{curl::curl} }
 }
 \details{
@@ -53,11 +55,7 @@ as an \code{xts} object.
 }
 \references{ Yahoo! Finance: \url{https://finance.yahoo.com}}
 \author{ Jeffrey A. Ryan }
-\note{ 
-This function is very preliminary - and will most likely
-change significantly in the future.
-}
-\seealso{ \code{\link{getSymbols}} }
+\seealso{ \code{\link{getSymbols}}, \code{\link{getSplits}} }
 \examples{
 \dontrun{
 getSymbols("MSFT")

man/getSplits.Rd

@@ -15,6 +15,7 @@ getSplits(Symbol,
           auto.update = FALSE, 
           verbose = FALSE,
           ...,
+          colname=NULL,
           curl.options = list())
 }
 %- maybe also 'usage' for other objects documented here.
@@ -28,6 +29,7 @@ getSplits(Symbol,
   \item{auto.update}{ automatically add split to data object }
   \item{verbose}{ display status of retrieval }
   \item{\dots}{ currently unused }
+  \item{colname}{ name for the column of data }
   \item{curl.options}{ options passed to \code{curl::curl} }
 }
 \details{
@@ -50,11 +52,7 @@ as an \code{xts} object.  \code{NA} is returned if there
 is no split data.
 }
 \references{ Yahoo! Finance: \url{https://finance.yahoo.com}}
-\author{ Josh Ulrich }
-\note{ 
-This function is very preliminary - and will most likely
-change significantly in the future.
-}
+\author{ Joshua Ulrich }
 \seealso{ \code{\link{getSymbols}}, \code{\link{getDividends}} }
 \examples{
 \dontrun{