Load Financial Dividend Data
Download, or download and append stock dividend data from Yahoo! Finance.
getDividends(Symbol, from = "1970-01-01", to = Sys.Date(), env = parent.frame(), src = "yahoo", auto.assign = FALSE, auto.update = FALSE, verbose = FALSE, split.adjust = TRUE, ..., curl.options = list())
Symbol |
The Yahoo! stock symbol |
from |
date from in CCYY-MM-DD format |
to |
date to in CCYY-MM-DD format |
env |
where to create object |
src |
data source (only yahoo is valid at present) |
auto.assign |
should results be loaded to env |
auto.update |
automatically add dividend to data object |
verbose |
display status of retrieval |
split.adjust |
adjust dividends for splits ( |
... |
currently unused |
curl.options |
options passed to |
Eventually destined to be a wrapper function along the lines
of getSymbols
to different sources - this currently
only support Yahoo data.
If auto.assign is TRUE, the symbol will be written
to the environment specified in env
with a
.div appended to the name.
If auto.update is TRUE and the object is of class
xts
, the dividends will be included as an
attribute of the original object and be reassigned
to the environment specified by env
.
All other cases will return the dividend data
as an xts
object.
This function is very preliminary - and will most likely change significantly in the future.
Jeffrey A. Ryan
Yahoo! Finance: https://finance.yahoo.com
## Not run: getSymbols("MSFT") getDividends("MSFT") getDividends(MSFT) ## End(Not run)
Please choose more modern alternatives, such as Google Chrome or Mozilla Firefox.