EVOLUTION-MANAGER
Edit File: getSymbols.FRED.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: Download Federal Reserve Economic Data - FRED(R)</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 getSymbols.FRED {quantmod}"><tr><td>getSymbols.FRED {quantmod}</td><td style="text-align: right;">R Documentation</td></tr></table> <h2> Download Federal Reserve Economic Data - FRED(R) </h2> <h3>Description</h3> <p>R access to over 11,000 data series accessible via the St. Louis Federal Reserve Bank's FRED system. </p> <p>Downloads <code>Symbols</code> to specified <code>env</code> from ‘research.stlouisfed.org’. This method is not to be called directly, instead a call to <code>getSymbols(Symbols,src='FRED')</code> will in turn call this method. It is documented for the sole purpose of highlighting the arguments accepted, and to serve as a guide to creating additional getSymbols ‘methods’. </p> <h3>Usage</h3> <pre> getSymbols.FRED(Symbols, env, return.class = "xts", ...) </pre> <h3>Arguments</h3> <table summary="R argblock"> <tr valign="top"><td><code>Symbols</code></td> <td> <p> a character vector specifying the names of each symbol to be loaded</p> </td></tr> <tr valign="top"><td><code>env</code></td> <td> <p> where to create objects. (.GlobalEnv) </p> </td></tr> <tr valign="top"><td><code>return.class</code></td> <td> <p> class of returned object </p> </td></tr> <tr valign="top"><td><code>...</code></td> <td> <p> additional parameters </p> </td></tr> </table> <h3>Details</h3> <p>Meant to be called internally by <code>getSymbols</code> (see also). </p> <p>One of many methods for loading data for use with <span class="pkg">quantmod</span>. Essentially a simple wrapper to the underlying FRED data download site. </p> <p>Naming conventions must follow those as seen on the Federal Reserve Bank of St Louis's website for FRED. A lookup facility will hopefully be incorporated into <span class="pkg">quantmod</span> in the near future. </p> <h3>Value</h3> <p>A call to getSymbols.FRED will load into the specified environment one object for each <code>Symbol</code> specified, with class defined by <code>return.class</code>. Presently this may be <code>ts</code>, <code>zoo</code>, <code>xts</code>, or <code>timeSeries</code>. </p> <h3>Note</h3> <p>FRED changed its URL scheme for the downloads from http:// to https://. If <code>getSymbols.FRED</code> fails for this reason, try one of the following solutions: </p> <ol> <li><p>Explicitly pass <code>method</code> via the <code>getSymbols</code> call (or via <code>setDefaults</code>). </p> </li> <li><p>Install <span class="pkg">downloader</span>, which may be able to automagically determine a suitable method. </p> </li> <li><p>Set the <code>download.file.method</code> global option. </p> </li></ol> <h3>Author(s)</h3> <p> Jeffrey A. Ryan </p> <h3>References</h3> <p> St. Louis Fed: Economic Data - FRED <a href="https://fred.stlouisfed.org/">https://fred.stlouisfed.org/</a> </p> <h3>See Also</h3> <p><code><a href="getSymbols.html">getSymbols</a></code>, <code><a href="setSymbolLookup.html">setSymbolLookup</a></code> </p> <h3>Examples</h3> <pre> ## Not run: # All 3 getSymbols calls return the same # CPI data to the global environment # The last example is what NOT to do! ## Method #1 getSymbols('CPIAUCNS',src='FRED') ## Method #2 setDefaults(getSymbols,src='FRED') # OR setSymbolLookup(CPIAUCNS='FRED') getSymbols('CPIAUCNS') ######################################### ## NOT RECOMMENDED!!! ######################################### ## Method #3 getSymbols.FRED('CPIAUCNS',env=globalenv()) ## 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>