EVOLUTION-MANAGER
Edit File: getDividends.html
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><title>R: Load Financial Dividend Data</title> <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> <link rel="stylesheet" type="text/css" href="R.css" /> </head><body> <table width="100%" summary="page for getDividends {quantmod}"><tr><td>getDividends {quantmod}</td><td style="text-align: right;">R Documentation</td></tr></table> <h2> Load Financial Dividend Data </h2> <h3>Description</h3> <p>Download, or download and append stock dividend data from Yahoo! Finance. </p> <h3>Usage</h3> <pre> 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()) </pre> <h3>Arguments</h3> <table summary="R argblock"> <tr valign="top"><td><code>Symbol</code></td> <td> <p> The Yahoo! stock symbol </p> </td></tr> <tr valign="top"><td><code>from</code></td> <td> <p> date from in CCYY-MM-DD format </p> </td></tr> <tr valign="top"><td><code>to</code></td> <td> <p> date to in CCYY-MM-DD format </p> </td></tr> <tr valign="top"><td><code>env</code></td> <td> <p> where to create object </p> </td></tr> <tr valign="top"><td><code>src</code></td> <td> <p> data source (only yahoo is valid at present)</p> </td></tr> <tr valign="top"><td><code>auto.assign</code></td> <td> <p> should results be loaded to env</p> </td></tr> <tr valign="top"><td><code>auto.update</code></td> <td> <p> automatically add dividend to data object </p> </td></tr> <tr valign="top"><td><code>verbose</code></td> <td> <p> display status of retrieval </p> </td></tr> <tr valign="top"><td><code>split.adjust</code></td> <td> <p> adjust dividends for splits (<code>TRUE</code> by default because that's what Yahoo returns)</p> </td></tr> <tr valign="top"><td><code>...</code></td> <td> <p> currently unused </p> </td></tr> <tr valign="top"><td><code>curl.options</code></td> <td> <p> options passed to <code>curl::curl</code> </p> </td></tr> </table> <h3>Details</h3> <p>Eventually destined to be a wrapper function along the lines of <code>getSymbols</code> to different sources - this currently only support Yahoo data. </p> <h3>Value</h3> <p>If auto.assign is TRUE, the symbol will be written to the environment specified in <code>env</code> with a .div appended to the name. </p> <p>If auto.update is TRUE and the object is of class <code>xts</code>, the dividends will be included as an attribute of the original object and be reassigned to the environment specified by <code>env</code>. </p> <p>All other cases will return the dividend data as an <code>xts</code> object. </p> <h3>Note</h3> <p>This function is very preliminary - and will most likely change significantly in the future. </p> <h3>Author(s)</h3> <p> Jeffrey A. Ryan </p> <h3>References</h3> <p> Yahoo! Finance: <a href="https://finance.yahoo.com">https://finance.yahoo.com</a></p> <h3>See Also</h3> <p><code><a href="getSymbols.html">getSymbols</a></code> </p> <h3>Examples</h3> <pre> ## Not run: getSymbols("MSFT") getDividends("MSFT") getDividends(MSFT) ## End(Not run) </pre> <hr /><div style="text-align: center;">[Package <em>quantmod</em> version 0.4.20 <a href="00Index.html">Index</a>]</div> </body></html>