quantmod June 9, 2008

Transcription

1 quantmod June 9, 2008 Type Package Title Quantitative Financial Modelling Framework Version Revision 433 Date Author Depends xts(>= ),zoo,Defaults Suggests DBI,RMySQL,RSQLite,TTR(>= ),fSeries,its Maintainer Specify, build, trade, and analyse quantitative financial trading strategies LazyLoad yes License GPL-3 URL R topics documented: Delt Lag Next OHLC.Transformations TA addadx addbbands addexpiry addma addmacd addroc addrsi addsar addsmi addvo

2 2 Delt addwpr builddata buildmodel chartseries charttheme chob-class chobta-class fittedmodel getdividends getfx getfinancials getmetals getmodeldata getquote getsymbols.fred getsymbols.mysql getsymbols getsymbols.sqlite getsymbols.csv getsymbols.google getsymbols.oanda getsymbols.rda getsymbols.yahoo has.ohlc internal-quantmod is.quantmod modeldata modelsignal newta options.expiry periodreturn quantmod-class quantmod-package quantmod.ohlc setsymbollookup setta specifymodel trademodel zoomchart Index 73 Delt Calculate Percent Change Calculate the k-period percent difference within one series, or between two series. Primarily used to calculate the percent change from one period to another of a given series, or to calculate the percent difference between two series over the full series.

3 Delt 3 Delt(x1, x2 = NULL, k = 0, type = c("arithmetic", "log")) x1 x2 k type m x 1 vector m x 1 vector change over k-periods. default k=1 when x2 is NULL. type of difference. log or arithmetic (defauly). When called with only x1, the one period percent change of the series is returned by default. Internally this happens by copying x1 to x2. A two period difference would be specified with k=2. If called with both x1 and x2, the difference between the two is returned. That is, k=0. A one period difference would be specified by k=1. k may also be a vector to calculate more than one period at a time. The results will then be an m x length(k) Log differences are used by default: Lag = log(x2(t)/x1(t-k)) Arithmetic differences are calculated: Lag = (x2(t) - x1(t-k))/x1(t-k) An matrix of length(x1) rows and length(k) columns. OpOp OpCl Stock.Open <- c(102.25,102.87,102.25,100.87,103.44,103.87,103.00) Stock.Close <- c(102.12,102.62,100.12,103.00,103.87,103.12,105.12) Delt(Stock.Open) Delt(Stock.Open,k=1) Delt(Stock.Open,type='arithmetic') Delt(Stock.Open,Stock.Close) Delt(Stock.Open,Stock.Close,k=0:2) #one period pct. price change #same #using arithmetic differences #Open to Close pct. change #...for 0,1, and 2 periods

4 4 Lag Lag Lag a Time Series Create a lagged series from data, with NA used to fill. Lag(x, k = 1) ## S3 method for class 'quantmod.ohlc': Lag(x, k = 1) ## S3 method for class 'zoo': Lag(x, k = 1) ## S3 method for class 'data.frame': Lag(x, k = 1) ## S3 method for class 'numeric': Lag(x, k = 1) x k vector or series to be lagged periods to lag. Note Shift series k-periods down, prepending NAs to front of series. Specifically designed to handle quantmod.ohlc and zoo series within the quantmod workflow. If no S3 method is found, a call to lag in base is made. The original x prepended with k NAs and missing the trailing k values. The returned series maintains the number of obs. of the original. This function differs from lag by returning the original series modified, as opposed to simply changing the time series properties. It differs from the like named Lag in the Hmisc as it deals primarily with time-series like objects. It is important to realize that if there is no applicable method for Lag, the value returned will be from lag in base. That is, coerced to ts if necessary, and subsequently shifted.

5 Next 5 lag Stock.Close <- c(102.12,102.62,100.12,103.00,103.87,103.12,105.12) Close.Dates <- as.date(c(10660,10661,10662,10665,10666,10667,10668),origin=" ") Stock.Close <- zoo(stock.close,close.dates) Lag(Stock.Close) Lag(Stock.Close,k=1) Lag(Stock.Close,k=1:3) #lag by 1 period #same #lag 1,2 and 3 periods Next Advance a Time Series Create a new series with all values advanced forward one period. The value of period 1, becomes the value at period 2, value at 2 becomes the original value at 3, etc. The opposite of Lag. NA is used to fill. Next(x, k = 1) ## S3 method for class 'quantmod.ohlc': Next(x,k=1) ## S3 method for class 'zoo': Next(x,k=1) ## S3 method for class 'data.frame': Next(x,k=1) ## S3 method for class 'numeric': Next(x,k=1) x k vector or series to be advanced periods to advance Shift series k-periods up, appending NAs to end of series. Specifically designed to handle quantmod.ohlc and zoo series within the quantmod workflow. If no S3 method is found, a call to lag in base is made, with the indexing reversed to shift the time series forward.

6 6 OHLC.Transformations Note The original x appended with k NAs and missing the leading k values. The returned series maintains the number of obs. of the original. Unlike Lag, only one value for k is allowed. This function s purpose is to get the next value of the data you hope to forecast, e.g. a stock s closing value at t+1. Specifically to be used within the quantmod framework of specifymodel, as a functional wrapper to the LHS of the model equation. It is not magic - and thus will not get tomorrow s values... specifymodel, Lag Stock.Close <- c(102.12,102.62,100.12,103.00,103.87,103.12,105.12) Close.Dates <- as.date(c(10660,10661,10662,10665,10666,10667,10668),origin=" ") Stock.Close <- zoo(stock.close,close.dates) Next(Stock.Close) Next(Stock.Close,k=1) #one period ahead #same merge(next(stock.close),stock.close) # a simple way to build a model of next days # IBM close, given todays. Technically both # methods are equal, though the former is seen # as more intuitive...ymmv specifymodel(next(cl(ibm)) ~ Cl(IBM)) specifymodel(cl(ibm) ~ Lag(Cl(IBM))) OHLC.Transformations Extract and Transform OHLC Time-Series Columns Extract (transformed) data from a suitable OHLC object. Column names must contain the complete description - either Open, High, Low, Close, Volume, or Adjusted - though may also contain additional characters. This is the default for objects returned from most getsymbols calls.

7 OHLC.Transformations 7 In the case of functions consisting of combined Op, Hi, Lo, Cl (e.g. ClCl(x)) the one period transformation will be applied. For example, to return the Open to Close of a object it is possible to call OpCl(x). If multiple periods are desired a call to the function Delt is necessary. serieslo and serieshi will return the low and high, respectively, of a given series. HLC extracts the High, Low, and Close columns. OHLC extracts the Open, High, Low, and Close columns. These functions are merely to speed the model specification process. All columns may also be extracted through standard R methods. Assignment will not work at present. Op(x) Hi(x) Lo(x) Cl(x) Vo(x) Ad(x) serieshi(x) serieslo(x) OpCl(x) ClCl(x) HiCl(x) LoCl(x) LoHi(x) OpHi(x) OpLo(x) OpOp(x) HLC(x) OHLC(x) x A data object with columns containing data to be extracted. Internally, the code uses grep to locate the appropriate columns. Therefore it is necessary to use inputs with column names matching the requirements in the description section, though the exact naming convention is not as important. Returns an object of the same class as the original series, with the appropriately column names if applicable and/or possible. The only exceptions are for quantmod.ohlc objects which will be returned as zoo objects, and calls to serieslo and serieshi which may return a numeric value instead of the original object type.

8 8 TA specifymodel getsymbols('ibm',src='yahoo') Ad(IBM) Cl(IBM) ClCl(IBM) serieshi(ibm) serieshi(lo(ibm)) removesymbols('ibm') TA Add Technical Indicator to Chart Functions to add technical indicators to a chart. The general mechanism to add technical analysis studies or overlays to a financial chart created with chartseries. Functionality marked with a * is via the TTR package. General TA charting tool functions: addta add data as custom indicator dropta remove technical indicator moveta move a technical indicator swapta swap two technical indicators Current technical indicators include: addadx add Welles Wilder s Directional Movement Indicator* addatr add Average True Range * addbbands: add Bollinger Bands * addcci add Commodity Channel Index * addcmf add Chaiken Money Flow * addcmo add Chande Momentum Oscillator * adddema add Double Exponential Moving Average *

9 TA 9 adddpo add Detrended Price Oscillator * addema add Exponential Moving Average * addenvelope add Moving Average Envelope addevwma add Exponential Volume Weighted Moving Average * addexpiry add options or futures expiration lines addlines add line(s) addmacd: add Moving Average Convergence Divergence * addmomentum add Momentum * addpoints add point(s) addroc: add Rate of Change * addrsi add Relative Strength Indicator * addsar add Parabolic SAR * addsma add Simple Moving Average * addsmi add Stochastic Momentum Index * addtrix add Triple Smoothed Exponential Oscillator * addvo: add Volume if available addwma add Weighted Moving Average * addwpr add Williams Percent R * addzlema add ZLEMA * See the individual functions for specific implementation and argument details. of the underlying TTR implementations can be found in TTR. The primary changes between the add*** version of an indicator and the TTR base function is the absense of the data argument in the former. Notable additions include on, with.col and overlay (deprecated). Called for its side effects, an object to class chobta will be returned invisibly. If called from the R command line the method will draw the appropriate indicator on the current chart. Note Calling any of the above methods from within a function or script will generally require them to be wrapped in a plot call as they rely on the context of the call to initiate the actual charting addition. References Josh Ulrich - TTR package

10 10 addadx addadx Add Directional Movement Index Add Directional Movement Index addadx(n = 14, matype="ema", wilder=true) n matype wilder periods to use for DX calculation moving average type should Welles Wilder EMA be used? See ADX in TTR for specific details and references. An ADX indicator will be draw in a new window on the current chart. A chobta object will be returned silently. References see ADX in TTR written by Josh Ulrich addta addadx()

11 addbbands 11 addbbands Add Bollinger Bands to Chart Add Bollinger Bands to current chart. addbbands(n = 20, sd = 2, ma = "SMA", draw = 'bands', on = -1) n ma sd draw on number of moving average periods type of moving average to be used number of standard deviations indicator to draw: bands, percent, or width which figure area of chart to apply to The primary addition to this function call over the TTR version is in the draw argument. bands will draw standard Bollinger Bands, percent will draw Bollinger %b and width will draw Bolinger Bands Width. The last two will be drawn in new figure regions. See bollingerbands in TTR for specific details as to implementation and references. Bollinger Bands will be drawn, or scheduled to be drawn, on the current chart. If draw is either percent or width a new figure will be added to the current TA figures charted. A chobta object will be returned silently. References See bollingerbands in TTR written by Josh Ulrich addta addbbands()

12 12 addma addexpiry Add Contract Expiration Bars to Chart Apply options or futures expiration vertical bars to current chart. addexpiry(type = "options", lty = "dotted") type lty options or futures expiration type of lines to draw See options.expiry and futures.expiry in quantmod for details and limitations. Expiration lines will be drawn at appropriate dates. A chibta object will be returned silently. addta addexpiry() addma Add Moving Average to Chart Add one or more moving averages to a chart.

13 addma 13 addsma(n = 10, on = 1, with.col = Cl, overlay = TRUE, col = "brown") addema(n = 10, wilder = FALSE, ratio=null, on = 1, with.col = Cl, overlay = TRUE, col = "blue") addwma(n = 10, wts=1:n, on = 1, with.col = Cl, overlay = TRUE, col = "green") adddema(n = 10, on = 1, with.col = Cl, overlay = TRUE, col = "pink") addevwma(n = 10, on = 1, with.col = Cl, overlay = TRUE, col = "yellow") addzlema(n = 10, ratio=null, on = 1, with.col = Cl, overlay = TRUE, col = "red") n wilder wts ratio on with.col overlay col periods to average over logical; use wilder? a vector of weights a smoothing/decay ratio apply to which figure (see below) using which column of data (see below) draw as overlay color of MA see the appropriate base MA functions in TTR for more details and references. A moving average indicator will be draw on the current chart. A chobta object will be returned silently. References see MovingAverages in pkgttr written by Josh Ulrich addta

14 14 addmacd addsma() addema() addwma() adddema() addevwma() addzlema() addmacd Add Moving Average Convergence Divergence to Chart Add Moving Average Convergence Divergence indicator to chart. addmacd(fast = 12, slow = 26, signal = 9, type = "EMA", histogram = TRUE, col) fast slow signal type histogram col fast period slow period signal period type of MA to use. Single values will be replicated include histogram colors to use for lines (optional) See and MACD in TTR for specific details and implementation references. A MACD indicator will be draw in a new window on the current chart. A chobta object will be returned silently. References see MACD in TTR written by Josh Ulrich addta

15 addroc 15 addmacd() addroc Add Rate Of Change to Chart Add Rate Of Change indicator to chart. addroc(n = 1, type = c("discrete", "continuous"), col = "red") n type col periods compounding type line color (optional) See ROC in TTR for specific details and references. A ROC indicator will be draw in a new window on the current chart. A chobta object will be returned silently. References see ROC in TTR written by Josh Ulrich addta addroc()

16 16 addrsi addrsi Add Relative Strength Index to Chart Add a Relative Strength Index indicator to chart. addrsi(n = 14, type = "EMA", wilder = TRUE) n type wilder periods type of MA to use use wilder (see EMA) see RSI in TTR for specific details and references. An RSI indicator will be draw in a new window on the current chart. A chobta object will be returned silently. References see RSI in TTR written by Josh Ulrich addta addrsi()

17 addsar 17 addsar Add Parabolic Stop and Reversal to Chart Add Parabolic Stop and Reversal indicator overlay to chart. addsar(accel = c(0.02, 0.2), col = "blue") accel col Accelleration factors - see SAR color of points (optional) see SAR in TTR for specific details and references. A SAR overlay will be drawn on the current chart. A chobta object will be returned silently. References see SAR in TTR written by Josh Ulrich addta addsar()

18 18 addsmi addsmi Add Stochastic Momentum Indicator to Chart Add Stochastic Momentum Indicator to chart. addsmi(n=13,slow=25,fast=2,signal=9,ma.type="ema") n slow fast signal ma.type periods slow fast signal MA tyep to use, recycled as necessary see SMI in TTR for specifics and references. An SMI indicator will be draw in a new window on the current chart. A chobta object will be returned silently. References see SMI in TTR written by Josh Ulrich addta addsmi()

19 addvo 19 addvo Add Volume to Chart Add Volume of a series, if available, to the current chart. This is the default TA argument for all charting functions. addvo() Add volume bars to current chart if data object contains appropriate volume column. Volume will be draw in a new window on the current chart. A chobta object will be returned silently. addta addvo() addwpr Add William s Percent R to Chart Add William s percent R indiator to the current chart. addwpr(n = 14) n periods

20 20 builddata see WPR in TTR for details and references. A William s percent R indicator will be draw in a new window on the current chart. A chobta object will be returned silently. References see WPR in TTR written by Josh Ulrich addta addwpr() builddata Create Data Object for Modelling Create one data object from multiple sources, applying transformations via standard R formula mechanism. builddata(formula, na.rm = TRUE, return.class = "zoo") formula na.rm an object of class formula (or one that can be coerced to that class): a symbolic description of the desired output data object, with the dependent side corresponding to first column, and the independent parameters of the formula assigned to the remaining columns. drop rows with missing values? return.class one of "zoo","data.frame","ts","its","timeseries"

21 buildmodel 21 Makes available for use outside the quantmod workflow a dataset of appropriately transformed variables, using the same mechanism underlying specifymodel. Offers the ability to apply transformations to raw data using a common formula mechanism, without having to explicitly merge different data objects. Interally calls specifymodel followed by modeldata, with the returned object being coerced to the desired return.class if possible, otherwise returns a zoo object. See getsymbols and specifymodel for more information regarding proper usage. An object of class return.class. getsymbols, specifymodel, modeldata builddata(next(opcl(dia)) ~ Lag(TBILL) + I(Lag(OpHi(DIA))^2)) builddata(next(opcl(dia)) ~ Lag(TBILL), na.rm=false) builddata(next(opcl(dia)) ~ Lag(TBILL), na.rm=false, return.class="ts") buildmodel Build quantmod model given specified fitting method Construct and attach a fitted model of type method to quantmod object. buildmodel(x, method, training.per,...) x An object of class quantmod created with specifymodel or an R formula training.per character vector representing dates in ISO 8601 format CCYY-MM-DD or CCYY-MM-DD HH:MM:SS of length 2 method A character string naming the fitting method. See details section for available methods, and how to create new methods.... Additional arguments to method call

22 22 chartseries Currently available methods include: lm, glm, loess, step, ppr, rpart[rpart], tree[tree], randomforest[randomforest], mars[mda], polymars[polspline], lars[lars], rq[quantreg], lqs[mass], rlm[mass], svm[e1071], and nnet[nnet]. The training.per should match the undelying date format of the time-series data used in modelling. Any other style may not return what you expect. Additional methods wrappers can be created to allow for modelling using custom functions. The only requirements are for a wrapper function to be constructed taking parameters quantmod, training.data, and.... The function must return the fitted model object and have a predict method available. It is possible to add predict methods if non exist by adding an S3 method for predictmodel. The buildmodel.skeleton function can be used for new methods. An object of class quantmod with fitted model attached Note See buildmodel.skeleton for information on adding additional methods Jeffrey Ryan specifymodel trademodel getsymbols('qqqq',src='yahoo') q.model = specifymodel(next(opcl(qqqq)) ~ Lag(OpHi(QQQQ),0:3)) buildmodel(q.model,method='lm',training.per=c(' ',' ')) chartseries Create Financial Charts Charting tool to create standard financial charts given a time series like object. Serves as the base function for future technical analysis additions. Possible chart styles include candles, matches (1 pixel candles), bars, and lines. Chart may have white or black background. rechart allows for dynamic changes to the chart without having to respecify the full chart parameters.

23 chartseries 23 chartseries(x, type = c("auto", "candlesticks", "matchsticks", "bars","line"), subset = NULL, show.grid = TRUE, name = NULL, time.scale = NULL, TA = 'addvo()', TAsep=';', line.type = "l", bar.type = "ohlc", theme = charttheme("black"), layout = NA, major.ticks='auto', minor.ticks=true, up.col,dn.col,color.vol = TRUE, multi.col = FALSE,...) rechart(type = c("auto", "candlesticks", "matchsticks", "bars","line"), subset = NULL, show.grid = TRUE, name = NULL, time.scale = NULL, line.type = "l", bar.type = "ohlc", theme = charttheme("black"), major.ticks='auto', minor.ticks=true, up.col,dn.col,color.vol = TRUE, multi.col = FALSE,...) x type subset show.grid name time.scale TA TAsep line.type bar.type theme layout major.ticks minor.ticks up.col dn.col an OHLC object - see details style of chart to draw xts style date subsetting argument display price grid lines? name of chart what is the timescale? automatically deduced a vector of technical indicators and params, or character strings TA delimiter for TA strings type of line in line chart type of barchart - ohlc or hlc a chart.theme object if NULL bypass internal layout where should major ticks be drawn should minor ticks be draw? up bar/candle color down bar/candle color

24 24 chartseries Note color.vol multi.col color code volume? 4 color candle pattern... additional parameters Currently displays standard style OHLC charts familiar in financial applications, or line charts when not passes OHLC data. Works with objects having explicit time-series properties. Line charts are created with close data, or from single column time series. The subset argument can be used to specify a particular area of the series to view. The underlying series is left intact to allow for TA functions to use the full data set. Additionally, it is possible to use syntax borrowed from the first and last functions, e.g. last 4 months. TA allows for the inclusion of a variety of chart overlays and tecnical indicators. A full list is available from addta. The default TA argument is addvo() - which adds volume, if available, to the chart being drawn. theme requires an object of class chart.theme, created by a call to charttheme. This function can be used to modify the look of the resulting chart. See chart.theme for details. line.type and bar.type allow further fine tuning of chart styles to user tastes. multi.col implements a color coding scheme used in some charting applications, and follows the following rules: grey => Op[t] < Cl[t] and Op[t] < Cl[t-1] white => Op[t] < Cl[t] and Op[t] > Cl[t-1] red => Op[t] > Cl[t] and Op[t] < Cl[t-1] black => Op[t] > Cl[t] and Op[t] > Cl[t-1] rechart takes any number of arguments from the original chart call and redraws the chart with the updated parameters. One item of note: if multiple color bars/candles are desired, it is necessary to respecify the theme argument. Additionally it is not possible to change TA parameters at present. This must be done with addta/dropta/swapta/moveta commands. Returns a standard chart plus volume, if available, suitably scaled. Most details can be fine-tuned within the function, though the code does a reasonable job of scaling and labelling axes for the user. The current implementation maintains a record of actions carried out for any particular chart. This is used to recreate the original when adding new indicator. A list of applied TA actions is available with a call to listta. This list can be assigned to a variable and used in new chart calls to recreate a set of technical indicators. It is also possible to force all future charts to use the same indicators by calling setta. Additional motivation to add outlined candles to allow for scaling and advanced color coding is owed to Josh Ulrich, as are the base functions (from TTR) for the yet to be released technical analysis charting code. Many improvements in the current version were the result of conversations with Gabor Grothendieck. Many thanks to him.

25 charttheme 25 References Josh Ulrich - TTR package and multi.col coding getsymbols, addta, setta, charttheme getsymbols("yhoo") chartseries(yhoo) chartseries(yhoo, subset='last 4 months') chartseries(yhoo, subset='2007:: ') chartseries(yhoo,theme=charttheme('white')) chartseries(yhoo,ta=null) #no volume chartseries(yhoo,ta=c(addvo(),addbbands())) #add volume and Bollinger Bands from TTR addmacd() # add MACD indicator to current chart setta() chartseries(yhoo) #draws chart again, this time will all indicators present charttheme Create A Chart Theme Create a chart.theme object for use within chartseries to manage desired chart colors. charttheme(theme = "black",...) theme name of base theme... name=value pairs to modify Used as an argument to the chartseries family of functions, charttheme allows for on-the-fly modification of pre-specified chart themes. Users can modify a pre-built theme in-place, or copy the theme to a new variable for use in subsequent charting calls. Internally a chart.theme object is nothing more than a list of values organized by chart components. The primary purpose of this is to facilitate minor modification on the fly, as well as provide a template for larger changes.

26 26 charttheme Setting style arguments for TA calls via charttheme requires the user to pass the styles as name=value pairs with a name containing the TA call in question. See examples for assistance. Current components that may be modified with appropriate values: fg.col foreground color bg.col background color grid.col grid color border border color minor.tick minor tickmark color major.tick major tickmark color up.col up bar/candle color dn.col down bar/candle color up.up.col up after up bar/candle color up.dn.col up after down bar/candle color dn.dn.col down after down bar/candle color dn.up.col down after up bar/candle color up.border up bar/candle border color dn.border down bar/candle border color up.up.border up after up bar/candle border color up.dn.border up after down bar/candle border color dn.dn.border down after down bar/candle border color dn.up.border down after up bar/candle border color A chart.theme object chartseries charttheme() charttheme('white') charttheme('white',up.col='blue',dn.col='red') # A TA example charttheme(addrsi.col='red') str(charttheme())

27 chob-class 27 chob-class A Chart Object Class Internal Objects for Tracking and Plotting Chart Changes Objects from the Class Slots Objects are created internally through the charting functions chartseries, barchart, linechart, and candlechart. device: Object of class "ANY" call: Object of class "call" name: Object of class "character" type: Object of class "character" passed.args: Object of class "ANY" windows: Object of class "numeric" xrange: Object of class "numeric" yrange: Object of class "numeric" length: Object of class "numeric" color.vol: Object of class "logical" multi.col: Object of class "logical" show.vol: Object of class "logical" show.grid: Object of class "logical" line.type: Object of class "character" bar.type: Object of class "character" xlab: Object of class "character" ylab: Object of class "character" spacing: Object of class "numeric" width: Object of class "numeric" bp: Object of class "numeric" x.labels: Object of class "character" colors: Object of class "ANY" time.scale: Object of class "ANY" major.ticks: Object of class "ANY" minor.ticks: Object of class "logical" Methods No methods defined with class "chob" in the signature.

28 28 chobta-class chartseries, or chobta for links to other classes showclass("chob") chobta-class A Technical Analysis Chart Object Internal storage class for handling arbitrary TA objects Objects from the Class Objects of class chobta are created and returned invisibly through calls to addta-style functions. Slots call: Object of class "call" on: Object of class "ANY" new: Object of class "logical" TA.values: Object of class "ANY" name: Object of class "character" params: Object of class "ANY" Methods show signature(object = "chobta"):... Note It is of no external vaule to handle chobta objects directly addta, or chob for links to other classes showclass("chobta")

29 fittedmodel 29 fittedmodel quantmod Fitted Objects Extract and replace fitted models from quantmod objects built with buildmodel. All objects fitted through methods specified in buildmodel calls can be extracted for further analysis. fittedmodel(object) fittedmodel(object) <- value ## S3 method for class 'quantmod': formula(x,...) ## S3 method for class 'quantmod': plot(x,...) ## S3 method for class 'quantmod': coefficients(object,...) ## S3 method for class 'quantmod': coef(object,...) ## S3 method for class 'quantmod': residuals(object,...) ## S3 method for class 'quantmod': resid(object,...) ## S3 method for class 'quantmod': fitted.values(object,...) ## S3 method for class 'quantmod': fitted(object,...) ## S3 method for class 'quantmod': anova(object,...) ## S3 method for class 'quantmod': loglik(object,...) ## S3 method for class 'quantmod': vcov(object,...) object x a quantmod object a quantmod object

30 30 fittedmodel value a new fitted model... additional arguments Most often used to extract the final fitted object of the modelling process, usually for further analysis with tools outside the quantmod package. Most common methods to apply to fitted objects are available to the parent quantmod object. At present, one can call directly the following S3 methods on a built model as if calling directly on the fitted object. See ** section. It is also possible to add a fitted model to an object. This may be of value when applying heuristic rule sets for trading approaches, or when fine tuning already fit models by hand. Returns an object matching that returned by a call to the method specified in buildmodel. Note The replacement function fittedmodel<- is highly experimental, and may or may not continue into further releases. The fitted model added must use the same names as appear in the quantmod object s dataset. quantmod,buildmodel x <- specifymodel(next(opcl(dia)) ~ OpCl(VIX)) x.lm <- buildmodel(x,method='lm',training.per=c(' ',' ')) fittedmodel(x.lm) coef(fittedmodel(x.lm)) coef(x.lm) vcov(fittedmodel(x.lm)) vcov(x.lm) # same # same

31 getdividends 31 getdividends Load Financial Dividend Data Download, or download and append stock dividend data from Yahoo! Finance. getdividends(symbol, from = " ", to = Sys.Date(), env =.GlobalEnv, src = "yahoo", auto.assign = TRUE, auto.update = TRUE, verbose = FALSE,...) 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... currently unused 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. Note This function is very preliminary - and will most likely change significantly in the future.

32 32 getfx References Yahoo! Finance: getsymbols getsymbols("msft") getdividends("msft") getdividends(msft) getfx Download Exchange Rates Download exchange rates or metals prices from oanda. getfx(currencies, from = " ", to = Sys.Date(), env =.GlobalEnv, verbose = FALSE, warning = TRUE, auto.assign = TRUE,...) Currencies from to env verbose warning auto.assign Currency pairs expressed as CUR/CUR start date expressed in ISO CCYY-MM-DD format end date expressed in ISO CCYY-MM-DD format which environment should they be loaded into be verbose show warnings use auto.assign... additional parameters to be passed to getsymbols.oanda method A convenience wrapper to getsymbols(x,src= oanda ). See getsymbols and getsymbls.oanda for more detail.

33 getfinancials 33 The results of the call will be the data will be assigned automatically to the environment specified (global by default). Additionally a vector of downloaded symbol names will be returned. See getsymbols and getsymbols.oanda for more detail. References Oanda.com getsymbols, getsymbols.oanda getfx("usd/jpy") getfx("eur/usd",from=" ") getfinancials Download and View Financial Statements Download Income Statement, Balance Sheet, and Cash Flow Statements from Google Finance. getfinancials(symbol, env =.GlobalEnv, src = "google", auto.assign = TRUE,...) viewfinancials(x, type=c('bs','is','cf'), period=c('a','q'), subset = NULL) Symbol env src auto.assign a valid google symbol where to create the object currently unused... currently unused x should results be loaded to the environment an object of class financials

34 34 getfinancials type period subset type of statement to view period of statement to view xts style subset string A utility to download financial statements for publically traded companies. The data is directly from Google finance. All use of the data is under there Terms of Service, available at http: // Individual statements can be accessed using standard R list extraction tools, or by using viewfinancials. viewfinancials allows for the use of date subsetting as available in the xts package, as well as the specification of the type of statement to view. BS for balance sheet, IS for income statement, and CF for cash flow statement. The period argument is used to identify which statements to view - (A) for annual and (Q) for quarterly. Six individual matricies organized in a list of class financials : IS BS CF a list containing (Q)uarterly and (A)nnual Income Statements a list containing (Q)uarterly and (A)nnual Balance Sheets a list containing (Q)uarterly and (A)nnual Cash Flow Statements Note As with all free data, you may be getting exactly what you pay for. References Google Finance BETA: JAVA <- getfinancials('java') AAPL <- getfin('aapl') JAVA$IS$Q AAPL$CF$A # Quarterly Income Statement # Annual Cash Flows str(aapl)

35 getmetals 35 getmetals Download Daily Metals Prices Download daily metals prices from oanda. getmetals(metals, from = " ", to = Sys.Date(), base.currency="usd", env =.GlobalEnv, verbose = FALSE, warning = TRUE, auto.assign = TRUE,...) Metals from metals expressed in common name or symbol form start date expressed in ISO CCYY-MM-DD format to end date expressed in ISO CCYY-MM-DD format base.currency which currency should the price be in env verbose warning auto.assign which environment should they be loaded into be verbose show warnings use auto.assign... additional parameters to be passed to getsymbols.oanda method A convenience wrapper to getsymbols(x,src= oanda ). The most useful aspect of getmetals is the ablity to specify the Metals in terms of underlying 3 character symbol or by name (e.g. XAU (gold), XAG (silver), XPD (palladium), or XPT (platinum)). There are unique aspects of any continuously traded commodity, and it is recommended that the user visit for details on specific pricing issues. See getsymbols and getsymbls.oanda for more detail. Data will be assigned automatically to the environment specified (global by default). If auto.assign is set to FALSE, the data from a single metal request will simply be returned from the function call. If auto.assign is used (the default) a vector of downloaded symbol names will be returned. See getsymbols and getsymbols.oanda for more detail.

36 36 getmodeldata References Oanda.com getsymbols, getsymbols.oanda getfx(c("gold","xpd")) getfx("plat",from=" ") getmodeldata Update model s dataset Update currently specified or built model with most recent data. getmodeldata(x, na.rm = TRUE) x na.rm An object of class quantmod Boolean. Remove NA values. Defaults to TRUE Primarily used within specify model calls, getmodeldata is used to retrieve the appropriate underlying variables, and apply model specified transformations automatically. It can be used to also update a current model in memory with the most recent data. Returns object of class quantmod.ohlc Jeffrey Ryan

37 getquote 37 getsymbols load data specifymodel create model structure buildmodel construct model modeldata extract model dataset my.model <- specifymodel(next(opcl(qqqq)) ~ Lag(Cl(NDX),0:5)) getmodeldata(my.model) getquote Download Current Stock Quote Fetch current stock quote(s) from specified source. At present this only handle sourcing quotes from Yahoo Finance, but it will be extended to additional sources over time. getquote(symbols, src = "yahoo", what = standardquote(),...) standardquote(src="yahoo") yahooqf(names) Symbols src what names character string of symbols, seperated by semi-colons source of data (only yahoo is implemented) what should be retrieved which data should be retrieved... currently unused A maximum of 200 symbols may be requested per call to Yahoo!, and all requested will be returned in one data.frame object. getquote returns a data frame with rows matching the number of Symbols requested, and the columns matching the requested columns. The what argument allows for specific data to be requested from yahoo, using Yahoo! s formatting string. A list and interactive selection tool can be seen with yahooqf. standardquote currently only applied to Yahoo! data, and returns an object of class quoteformat, for use within the getquote function.

38 38 getsymbols.fred References Yahoo! Finance finance.yahoo.com gummy-stuff.org htm getsymbols getquote("aapl") getquote("qqqq;spy;^vxn",what=yahooqf(c("bid","ask"))) standardquote() yahoofq() getsymbols.fred Download Federal Reserve Economic Data - FRED(R) R access to over 11,000 data series accessible via the St. Louis Federal Reserve Bank s FRED system. Downloads Symbols to specified env from research.stlouisfed.org. This method is not to be called directly, instead a call to getsymbols(symbols,src= FRED ) 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. getsymbols.fred(symbols, env, return.class = "xts",...) Symbols env a character vector specifying the names of each symbol to be loaded where to create objects. (.GlobalEnv) return.class class of returned object... additional parameters Meant to be called internally by getsymbols (see also). One of many methods for loading data for use with quantmod. Essentially a simple wrapper to the underlying FRED data download site. 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 quantmod in the near future.

39 getsymbols.mysql 39 A call to getsymbols.fred will load into the specified environment one object for each Symbol specified, with class defined by return.class. Presently this may be ts, its, zoo, xts, or timeseries. References St. Louis Fed: Economic Data - FRED getsymbols, setsymbollookup # 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()) getsymbols.mysql Retrieve Data from MySQL Database Fetch data from MySQL database. As with other methods extending the getsymbols function, this should NOT be called directly. Its documentation is meant to highlight the formal arguments, as well as provide a reference for further user contributed data tools.

40 40 getsymbols.mysql getsymbols.mysql(symbols, env, return.class = 'xts', db.fields = c("date", "o", "h", "l", "c", "v", "a"), field.names = NULL, user = NULL, password = NULL, dbname = NULL,...) Symbols a character vector specifying the names of each symbol to be loaded env where to create objects. (.GlobalEnv) return.class desired class of returned object. Can be xts, zoo, data.frame, ts, or its. (zoo) db.fields character vector indicating names of fields to retrieve field.names names to assign to returned columns user username to access database password password to access database dbname database name... currently not used Meant to be called internally by getsymbols (see also) One of a few currently defined methods for loading data for use with quantmod. Its use requires the packages DBI and MySQL, along with a running MySQL database with tables corresponding to the Symbol name. The purpose of this abstraction is to make transparent the source of the data, allowing instead the user to concentrate on the data itself. A call to getsymbols.mysql will load into the specified environment one object for each Symbol specified, with class defined by return.class. Note The default configuration needs a table named for the Symbol specified (e.g. MSFT), with column names date,o,h,l,c,v,a. For table layout changes it is best to use setdefaults(getsymbols.mysql,...) with the new db.fields values specified.

41 getsymbols 41 References MySQL AB David A. James and Saikat DebRoy (2006). R Interface to the MySQL databse. www. omegahat.org R-SIG-DB. DBI: R Database Interface getsymbols, setsymbollookup # All 3 getsymbols calls return the same # MSFT to the global environment # The last example is what NOT to do! setdefaults(getsymbols.mysql,user='jdoe',password='secret', dbname='tradedata') ## Method #1 getsymbols('msft',src='mysql') ## Method #2 setdefaults(getsymbols,src='mysql') # OR setsymbollookup(msft='mysql') getsymbols('msft') ######################################### ## NOT RECOMMENDED!!! ######################################### ## Method #3 getsymbols.mysql('msft',env=globalenv()) getsymbols Load and Manage Data from Multiple Sources Functions to load and manage Symbols in specified environment. Used by specifymodel to retrieve symbols specified in first step of modelling procedure. Not a true S3 method, but methods for different data sources follow an S3-like naming convention. Additional methods can be added by simply adhering to the convention. Current src methods available are: yahoo, google, MySQL, FRED, csv, RData, and Oanda. Data is loaded silently without user assignment by default.

42 42 getsymbols getsymbols(symbols = NULL, env =.GlobalEnv, reload.symbols = FALSE, verbose = FALSE, warnings = TRUE, src = "yahoo", symbol.lookup = TRUE, auto.assign = TRUE,...) showsymbols(env=.globalenv) removesymbols(symbols=null,env=.globalenv) savesymbols(symbols = NULL, file.path=stop("must specify 'file.path'"), env =.GlobalEnv) Symbols a character vector specifying the names of each symbol to be loaded env where to create objects. (.GlobalEnv) reload.symbols boolean to reload current symbols in specified environment. (FALSE) verbose warnings boolean to turn on status of retrieval. (FALSE) boolean to turn on warnings. (TRUE) src character string specifying sourcing method. (yahoo) symbol.lookup retrieve symbol s sourcing method from external lookup (TRUE) auto.assign file.path should results be loaded to the environment character string of file location... additional parameters getsymbols is a wrapper to load data from different sources - be them local or remote. Data is fetched through one of the available getsymbols methods and saved in the env specified - the.globalenv by default. Data is loaded in much the same way that load behaves. By default, it is assigned automatically to a variable in the specified environment, without the user explicitly assigning the returned data to a variable. The previous sentence s point warrants repeating - getsymbols is called for its side effects, and does not return the data object loaded. The data is loaded silently by the function into the user s environment - or an environment specified. This behavior can be overridden by setting auto.assign to FALSE, though it is not advised. By default the variable chosen is an R-legal name derived from the symbol being loaded. It is possible, using setsymbollookup to specify an alternate name if the default is not desired, see that function for details. The result of a call to getsymbols when auto.assign is set to TRUE (the default) is a new object or objects in the user s specified environment - with the loaded symbol(s) names returned upon exit.

43 getsymbols 43 Note If auto.assign is set to FALSE the data will be returned from the call, and will require the user to assign the results himself. Most, if not all, documentation and functionality in quantmod assumes that auto.assign remains set to TRUE. Upon completion a list of loaded symbols is stored in the global environment under the name.getsymbols. Objects loaded by getsymbols with auto.assign=true can be viewed with showsymbols and removed by a call to removesymbols. Additional data loading methods can be created simply by following the S3-like naming convention where getsymbols.name is used for your function NAME. See getsymbols source code. setdefaults(getsymbols) can be used to specify defaults for getsymbols arguments. setdefaults(getsymbols.mysql) may be used for arguments specific to getsymbols.mysql, etc. The sourcing of data is managed internally through a complex lookup procedure. If symbol.lookup is TRUE (the default), a check is made if any symbol has had its source specified by setsymbollookup. If not set, the process continues by checking to see if src has been specified by the user in the function call. If not, any src defined with setdefaults(getsymbols,src=) is used. Finally, if none of the other source rules apply the default getsymbols src method is used ( yahoo ). A call to getsymbols will load into the specified environment one object for each Symbol specified, with class defined by return.class. Presently this may be ts, its, zoo, xts, or timeseries. If auto.assign is set to FALSE an object of type return.class will be returned. While it is possible to load symbols as classes other than zoo, quantmod requires most, if not all, data to be of class zoo or inherited from zoo - e.g. xts. The additional methods are meant mainly to be of use for those using the functionality outside of the quantmod workflow. getmodeldata,specifymodel, setsymbollookup, getsymbols.csv, getsymbols.rdata, getsymbols.oanda, getsymbols.yahoo, getsymbols.google, getsymbols.fred, getfx, getmetals, setsymbollookup(qqqq='yahoo',spy='mysql') getsymbols(c('qqqq','spy')) # loads QQQQ from yahoo (set with setsymbollookup) # loads SPY from MySQL (set with setsymbollookup)

44 44 getsymbols.sqlite getsymbols('f') # loads Ford market data from yahoo (the formal default) setdefaults(getsymbols,verbose=true,src='mysql') getsymbols('dia') # loads symbol from MySQL database (set with setdefaults) getsymbols('f',src='yahoo',return.class='ts') # loads Ford as time series class ts getsymbols.sqlite Retrieve Data from SQLite Database Fetch data from SQLite database. As with other methods extending getsymbols this function should NOT be called directly. getsymbols.sqlite(symbols, env, return.class = 'xts', db.fields = c("row_names", "Open", "High", "Low", "Close", "Volume", "Adjusted"), field.names = NULL, dbname = NULL, POSIX = TRUE,...) Symbols a character vector specifying the names of each symbol to be loaded env where to create the objects return.class desired class of returned object db.fields character vector naming fields to retrieve field.names names to assign to returned columns dbname database name POSIX are rownames numeric... additional arguments

45 getsymbols.csv 45 Meant to be called internally by getsymbols (see also) One of a few currently defined methods for loading data for use with quantmod. Its use requires the packages DBI and RSQLite, along with a SQLite database. The purpose of this abstraction is to make transparent the source of the data, allowing instead the user to concentrate on the data itself. A call to getsymbols.sqlite will load into the specified environment one object for each Symbol specified, with class defined by return.class. Note This function is experimental at best, and has not been thoroughly tested. Use with caution, and please report any bugs to the maintainer of quantmod. References SQLite David A. James RSQLite: SQLite interface for R R-SIG-DB. DBI: R Database Interface getsymbols getsymbols("qqqq",src="sqlite") getsymbols.csv Load Data from csv File Downloads Symbols to specified env from local comma seperated file. This method is not to be called directly, instead a call to getsymbols(symbols,src= csv ) 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.

46 46 getsymbols.csv getsymbols.csv(symbols, env, dir="", return.class = "xts", extension="csv",...) Symbols env dir Note a character vector specifying the names of each symbol to be loaded where to create objects. (.GlobalEnv) directory of csv file return.class class of returned object extension extension of csv file... additional parameters Meant to be called internally by getsymbols (see also). One of a few currently defined methods for loading data for use with quantmod. Essentially a simple wrapper to the underlying R read.csv. A call to getsymbols.csv will load into the specified environment one object for each Symbol specified, with class defined by return.class. Presently this may be ts, its, zoo, xts, or timeseries. This has yet to be tested on a windows platform. It should work though file seperators may be an issue. getsymbols, read.csv, setsymbollookup # All 3 getsymbols calls return the same # MSFT to the global environment # The last example is what NOT to do! ## Method #1 getsymbols('msft',src='csv')

47 getsymbols.google 47 ## Method #2 setdefaults(getsymbols,src='csv') # OR setsymbollookup(msft='csv') getsymbols('msft') ######################################### ## NOT RECOMMENDED!!! ######################################### ## Method #3 getsymbols.csv('msft',verbose=true,env=globalenv()) getsymbols.google Download OHLC Data From Google Finance Downloads Symbols to specified env from finance.google.com. This method is not to be called directly, instead a call to getsymbols(symbols,src= google ) 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. getsymbols.google(symbols, env, return.class = 'xts', from = " ", to = Sys.Date(),...) Symbols env a character vector specifying the names of each symbol to be loaded where to create objects. (.GlobalEnv) return.class class of returned object from to Retrieve no earlier than this date Retrieve though this date... additional parameters Meant to be called internally by getsymbols (see also). One of a few currently defined methods for loading data for use with quantmod. Essentially a simple wrapper to the underlying Google Finance site for historical data. A word of warning. Google is the home of BETA, and historic data is no exception. There is a BUG in practically all series that include the dates Dec 29,30, and 31 of The data will show the wrong date and corresponding prices. This essentially makes it useless, but if they ever apply a fix the data is nice(r) than Yahoo, in so much as it is all split adjusted and there is forty years worth to be had. As long as you skip the holiday week of : )

48 48 getsymbols.google A call to getsymbols.google will load into the specified environment one object for each Symbol specified, with class defined by return.class. Presently this may be ts, its, zoo, xts, or timeseries. Note As mentioned in the details section, a serious flaw exists within the google database/sql. A caution is issued when retrieving data via this method if this particular error is encountered, but one can only wonder what else may be wrong. Caveat emptor. References Google Finance: getsymbols, setsymbollookup # All 3 getsymbols calls return the same # MSFT to the global environment # The last example is what NOT to do! ## Method #1 getsymbols('msft',src='google') ## Method #2 setdefaults(getsymbols,src='google') # OR setsymbollookup(msft='google') getsymbols('msft') ######################################### ## NOT RECOMMENDED!!! ######################################### ## Method #3 getsymbols.google('msft',verbose=true,env=globalenv())

49 getsymbols.oanda 49 getsymbols.oanda Download Currency and Metals Data from Oanda.com Access to 191 currency and metal prices, downloadable as more that currency pairs from Oanda.com. Downloads Symbols to specified env from historical currency database. This method is not meant to be called directly, instead a call to getsymbols(\dquote{x},src=\dquote{oanda}) 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. getsymbols.oanda(symbols, env, return.class = "xts", from = " ", to = Sys.Date(),...) Symbols env a character vector specifying the names of each symbol to be loaded - expressed as a currency pair. (e.g. U.S. Dollar to Euro rate would be expressed as a string USD/EUR. The naming convention follows from Oanda.com, and a table of possible values is available by calling oanda.currencies where to create objects. return.class class of returned object from to Start of series expressed as "CCYY-MM-DD" Start of series expressed as "CCYY-MM-DD"... additional parameters Meant to be called internally by getsymbols only. Oanda data is 7 day daily average price data, that is Monday through Sunday. There is a limit of 2000 days per request, and getsymbols will fail with a warning that the limit has been exceeded. A call to getsymbols(symbols,src="oanda") will load into the specified environment one object for each Symbol specified, with class defined by return.class. Presently this may be ts, its, zoo, xts, or timeseries. Note Oanda rates are quoted as one unit of base currency to the equivelant amount of foreign currency.

50 50 getsymbols.rda References Oanda.com Currencies: getsymbols.fred, getsymbols getsymbols("usd/eur",src="oanda") getsymbols("usd/eur",src="oanda",from=" ") getsymbols.rda Load Data from R Binary File Downloads Symbols to specified env from local R data file. This method is not to be called directly, instead a call to getsymbols(symbols,src= rda ) 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. getsymbols.rda(symbols, env, dir="", return.class = "xts", extension="rda", col.names=c("open","high","low","close","volume","adjusted"),...) Symbols a character vector specifying the names of each symbol to be loaded env where to create objects. (.GlobalEnv) dir directory of rda/rdata file return.class class of returned object extension extension of R data file col.names data column names... additional parameters

51 getsymbols.yahoo 51 Meant to be called internally by getsymbols (see also). One of a few currently defined methods for loading data for use with quantmod. Essentially a simple wrapper to the underlying R load. A call to getsymbols.csv will load into the specified environment one object for each Symbol specified, with class defined by return.class. Presently this may be ts, its, zoo, xts, data.frame, or timeseries. getsymbols, load, setsymbollookup # All 3 getsymbols calls return the same # MSFT to the global environment # The last example is what NOT to do! ## Method #1 getsymbols('msft',src='rda') getsymbols('msft',src='rdata') ## Method #2 setdefaults(getsymbols,src='rda') # OR setsymbollookup(msft='rda') # OR setsymbollookup(msft=list(src='rda')) getsymbols('msft') ######################################### ## NOT RECOMMENDED!!! ######################################### ## Method #3 getsymbols.rda('msft',verbose=true,env=globalenv()) getsymbols.yahoo Download OHLC Data From Yahoo Finance

52 52 getsymbols.yahoo Downloads Symbols to specified env from finance.yahoo.com. This method is not to be called directly, instead a call to getsymbols(symbols,src= yahoo ) 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. getsymbols.yahoo(symbols, env, return.class = 'xts', from = " ", to = Sys.Date(),...) Symbols a character vector specifying the names of each symbol to be loaded env where to create objects. (.GlobalEnv) return.class class of returned object from Retrieve data no earlier than this date. ( ) to Retrieve data through this date (Sys.Date())... additional parameters Meant to be called internally by getsymbols (see also). One of a few currently defined methods for loading data for use with quantmod. Essentially a simple wrapper to the underlying Yahoo! finance site s historical data download. A call to getsymbols.yahoo will load into the specified environment one object for each Symbol specified, with class defined by return.class. Presently this may be ts, its, zoo, xts, or timeseries. References Yahoo Finance: getsymbols, setsymbollookup

53 has.ohlc 53 # All 3 getsymbols calls return the same # MSFT to the global environment # The last example is what NOT to do! ## Method #1 getsymbols('msft',src='yahoo') ## Method #2 setdefaults(getsymbols,src='yahoo') # OR setsymbollookup(msft='yahoo') getsymbols('msft') ######################################### ## NOT RECOMMENDED!!! ######################################### ## Method #3 getsymbols.yahoo('msft',env=globalenv()) has.ohlc Check For OHLC Data A set of functions to check for appropriate OHLC and HLC column names within a data object, as well as the availability and position of those columns. is.ohlc(x) has.ohlc(x, which = FALSE) is.hlc(x) has.hlc(x, which = FALSE) has.op(x, which = FALSE) has.hi(x, which = FALSE) has.lo(x, which = FALSE) has.cl(x, which = FALSE) has.vo(x, which = FALSE) has.ad(x, which = FALSE) x which data object disply position of match

54 54 internal-quantmod Mostly used internally by quantmod, they can be useful for checking whether an object can be used in OHLC requiring functions like Op, OpCl, etc. Columns names must contain the full description of data, that is, Open, High, Low, Close, Volume or Adjusted. Abbreviations will return FALSE (or NA when which=true). See quantmod.ohlc for details of quantmod naming conventions. is.ohlc (and is.hlc, similarly) will only return TRUE is there are columns for Open, High, Low and Close. Additional columns will not affect the value. A logical value indicating success or failure by default. If which=true, a numeric value representing the column position will be returned. is.ohlc and is.hlc return a single value of TRUE or FALSE. quantmod.ohlc,ohlc.transformations getsymbols("yhoo") is.ohlc(yhoo) has.ohlc(yhoo) has.ad(yhoo) internal-quantmod Internal quantmod Objects To be documented...

55 is.quantmod 55 is.quantmod Test If Object of Type quantmod Test if object is of type quantmod or quantmodresults. is.quantmod(x) is.quantmodresults(x) x object to test Boolean TRUE or FALSE specifymodel, trademodel modeldata Extract Dataset Created by specifymodel Extract from a quantmod object the dataset created for use in modelling. specifymodel creates a zoo object for use in subsequent workflow stages ( buildmodel,trademodel) that combines all model inputs, from a variety of sources, into one model frame. modeldata returns this object. modeldata(x, data.window = NULL, exclude.training = FALSE) x a quantmod object data.window a character vector of subset start and end dates to return exclude.training remove training period

56 56 modelsignal When a model is created by specifymodel, it is attached to the returned object. One of the slots of this S4 class is model.data. an object of class zoo containing all transformations to data specified in specifymodel. specifymodel,getmodeldata m <- specifymodel(next(opcl(spy)) ~ Cl(SPY) + OpHi(SPY) + Lag(Cl(SPY))) modeldata(m) modelsignal Extract Model Signal Object Extract model signal object from quantmodresults object as an object of class zoo. modelsignal(x) x object of class quantmodresults For use after a call to trademodel to extract the generated signal of a given quantmod model. Normally this would not need to be called by the end user unless he was manually post processing the trade results. A zoo object indexed by signal dates.

57 newta 57 trademodel newta Create A New TA Indicator For chartseries Functions to assist in the creation of indicators or content to be drawn on plots produced by chart- Series. addta(ta, order = NULL, on = NA, legend = "auto",...) newta(fun, tfun, on = NA, legend.name, fdots = TRUE, cdots = TRUE, data.at = 1,...) ta order legend FUN tfun on legend.name fdots cdots data.at data to be plotted which should the columns (if > 1) be plotted what custom legend text should be added to the chart. Main filter function name - as a symbol Pre-filter transformation or extraction function where to draw optional legend heading, automatically derived otherwise should any... be included in the main filter call should any... be included in the resultant function object. fdots=true will override this to TRUE. which arguement to the main filter function is for data.... any additonal graphical parameters/default to be included.

58 58 newta Both addta and newta can be used to dynamically add custom content to a displayed chart. addta takes a series of values, either in a form coercible to xts or of the same length as the charted series has rows, and displays the results in either a new TA sub-window, or over/underlayed on the main price chart. If the object can be coerced to xts, the time values present must only be within the original series time-range. Internally a merge of dates occurs and will allow for the plotting of discontinuous series. The order argument allows for multiple column data to be plotted in an order that makes the most visual sense. Specifying a legend will override the standard parsing of the addta call to attempt a guess at a suitable title for the sub-chart. Specifying this will cause the standard last value to not be printed. The... arg to addta is used to set graphical parameters interpretable by lines. newta acts as more of a skeleton function, taking functions as arguments, as well as charting parameters, and returns a function that can be called in the same manner as the built-in TA tools, such as addrsi and addmacd. Essentially a dynamic code generator that allows for highly customizable chart tools with minimal (possibly zero) coding. It is also possible to modify the resultant code to further change behavior. To create a new TA function with newta certain arguments must be specified. The FUN argument is a function symbol (or coercible to such) that is the primary filter to be used on the core-data of a chartseries chart. This can be like most of the functions within the TTR package e.g. RSI or EMA. The resultant object of the function call will be equal to calling the function on the original data passed into the chartseries function that created the chart. It should be coercible to a matrix object, of one or more columns of output. By default all columns of output will be added to the chart, unless suppressed by passing the appropriately positioned type= n as the... arg. Note that this will not suppress the labels added to the chart. The tfun argument will be called on the main chart s data prior to passing it to FUN. This must be a function symbol or a character string of the name function to be called. The on is used to identify which subchart to add the graphic to. By default, on=na will draw the series in a new subchart below the last indicator. Setting this to either a positive or negative value will allow for the series to be super-imposed on, or under, the (sub)chart specified, respectively. A value of 1 refers to the main chart, and at present is the only location supported. legend.name will change the main label for a new plot. fdots and cdots enable inclusion or suppression of the... within the resulting TA code s call to FUN, or the argument list of the new TA function, respectively. In order to facilitate user-specified graphical parameters it is usually desireable to not impose artificial limits on the end-user with constraints on types of parameters available. By default the new TA function will include the dots argument, and the internal FUN call will keep all arguments, including the dots. This may pose issues if the internal function then passes those... arguments to a function that can t handle them. The final argument is data.at which is the position in the FUN argument list which expects the data to be passed in at. This default to the sensible first position, though can be changed at the time of creation by setting this argument to the required value. While the above functions are usually sufficient to construct very pleasing graphical additions to a chart, it may be necessary to modify by-hand the code produced. This can be accomplished by dumping the function to a file, or using fix on it during an interactive session. Another item of note, with respect to newta is the naming of the main legend label. Following addta convention, the first add is stripped from the function name, and the rest of the call s name is used as the label. This can be overridden by specifying legend.name in the construction of

59 options.expiry 59 Note the new TA call, or by passing legend into the new TA function. Subtle differences exist, with the former being the preferred solution. While both functions can be used to build new indicators without any understanding of the internal chartseries process, it may be beneficial in more complex cases to have a knowledge of the multistep process involved in creating a chart via chartseries. to be added... addta will invisibly return an S4 object of class chobta. If this function is called interactively, the chobta object will be evaluated and added to the current chart. newta will return a function object that can either be assigned or evaluated. Evaluating this function will follow the logic of any standard addta-style call, returning invisibly a chobta object, or adding to the chart. Both interfaces are meant to fascilitate custom chart additions. addta is for adding any arbitrary series to a chart, where-as newta works with the underlying series with the main chart object. The latter also acts as a dynamic TA skeleton generation tool to help develop reusable TA generation code for use on any chart. chartseries, TA, chob, chobta getsymbols('sbux') barchart(sbux) addta(ema(cl(sbux)), on=1, col=6) addta(opcl(sbux), col=4, type='b', lwd=2) # create new EMA TA function newema <- newta(ema, Cl, on=1, col=7) newema() newema(on=na, col=5) options.expiry Calculate Contract Expirations Return the index of the contract expiration date. The third Friday of the month for options, the last third Friday of the quarter for futures.

60 60 options.expiry options.expiry(x) futures.expiry(x) x a time-indexed zoo object Designed to be used within a charting context via addexpiry, the values returned are based on the description above. Exceptions, though rare, are not accounted for. A numeric vector of values to index on. Note There is currently no accounting for holidays that may interfere with the general rule. Additionally all efforts have been focused on US equity and futures markets. References put references to the literature/web site here addexpiry getsymbols("aapl") options.expiry(aapl) futures.expiry(aapl) AAPL[options.expiry(AAPL)]

61 periodreturn 61 periodreturn Calculate Periodic Returns Given a set of prices, return periodic returns. periodreturn(x, period='monthly', subset=null, type='arithmetic', leading=true,...) dailyreturn(x, subset=null, type='arithmetic', leading=true,...) weeklyreturn(x, subset=null, type='arithmetic', leading=true,...) monthlyreturn(x, subset=null, type='arithmetic', leading=true,...) quarterlyreturn(x, subset=null, type='arithmetic', leading=true,...) annualreturn(x, subset=null, type='arithmetic', leading=true,...) yearlyreturn(x, subset=null, type='arithmetic', leading=true,...) allreturns(x, subset=null, type='arithmetic', leading=true) x period subset type leading object of state prices, or an OHLC type object character string indicating time period. Valid entries are daily, weekly, monthly, quarterly, yearly. All are accessible from wrapper functions described below. Defaults to monthly returns (same as monthlyreturn) an xts/iso8601 style subset string type of returns: arithmetic (discrete) or log (continuous) should incomplete leading period returns be returned... passed along to to.period periodreturn is the underlying function for wrappers: allreturns: dailyreturn: weeklyreturn: calculate all available return periods calculate daily returns calculate weekly returns

62 62 quantmod-class monthlyreturn: calculate monthly returns quarterlyreturn: calculate quarterly returns annualreturn: calculate annual returns Returns object of the class that was originally passed in, with the possible exception of monthly and quarterly return indicies being changed to class yearmon and yearqtr where available. This can be overridden with the indexat argument passed in the... to the to.period function. By default, if subset is NULL, the full dataset will be used. Note Attempts are made to re-convert the resultant series to its original class, if supported by the xts package. At present, objects inheriting from the ts class are returned as xts objects. This is to make the results more visually appealling and informative. All xts objects can be converted to class ts with as.ts if that is desirable. The first and final row of returned object will have the period return to last date, i.e. this week/month/quarter/year return to date even if the start/end is not the start/end of the period. Leading period calculations can be suppressed by setting leading=false. getsymbols to.period getsymbols('qqqq',src='yahoo') allreturns(qqqq) # returns all periods periodreturn(qqqq,period='yearly',subset='2003::') # returns years 2003 to present periodreturn(qqqq,period='yearly',subset='2003') # returns year 2003 rm(qqqq) quantmod-class Class "quantmod" Objects of class quantmod help to manage the process of model building within the quantmod package. Created automatically by a call to specifymodel they carry information to be used by a variety of accessor functions and methods.

63 quantmod-package 63 Objects from the Class Objects can be created by calls of the form new("quantmod",...). Normally objects are created as a result of a call to specifymodel. Slots model.id: Object of class "character" model.spec: Object of class "formula" model.formula: Object of class "formula" model.target: Object of class "character" model.inputs: Object of class "character" build.inputs: Object of class "character" symbols: Object of class "character" product: Object of class "character" price.levels: Object of class "zoo" training.data: Object of class "Date" build.date: Object of class "Date" fitted.model: Object of class "ANY" model.data: Object of class "zoo" quantmod.version: Object of class "numeric" Methods No methods defined with class "quantmod" in the signature. showclass("quantmod") quantmod-package Quantitative Financial Modelling Framework Quantitative Financial Modelling and Trading Framework for R

64 64 quantmod.ohlc Package: quantmod Type: Package Version: Revision: 433 Date: Depends: xts(>=0.0-15),defaults Suggests: DBI,RMySQL,TTR,fSeries,its LazyLoad: yes License: GPL-3 URL: The quantmod package for R is designed to assist the quantitative trader in the development, testing, and deployment of statistically based trading models. What quantmod IS A rapid prototyping environment, where quant traders can quickly and cleanly explore and build trading models. What quantmod is NOT A replacement for anything statistical. It has no new modelling routines or analysis tool to speak of. It does now offer charting not currently available elsewhere in R, but most everything else is more of a wrapper to what you already know and love about the langauge and packages you currently use. quantmod makes modelling easier by removing the repetitive workflow issues surrounding data management, modelling interfaces, and performance analysis. Maintainer: <[email protected]> quantmod.ohlc Create Open High Low Close Object Coerce an object with the apporpriate columns to class quantmod.ohlc, which extends zoo. as.quantmod.ohlc(x, col.names = c("open", "High", "Low", "Close", "Volume", "Adjusted"), name = NULL,...)

65 setsymbollookup 65 x col.names name object of class zoo suffix for columns name to attach unique column suffixes to, defaults to the object name... additional arguments (unused) quantmod.ohlc is actually just a renaming of an object of class zoo, with the convention of NAME.Open, NAME.High,... for the column names. Additionally methods may be written to handle or check for the above conditions within other functions - as is the case within the quantmod package. An object of class c( quantmod.ohlc, zoo ) OHLC.Transformations, getsymbols setsymbollookup Manage Symbol Lookup Table Create and manage Symbol defaults lookup table within R session for use in getsymbols calls. setsymbollookup(...) getsymbollookup(symbols=null) unsetsymbollookup(symbols,confirm=true) savesymbollookup(file,dir="") loadsymbollookup(file,dir="")... name=value pairs for symbol defaults Symbols confirm file dir name of symbol(s) warn before deleting lookup table filename directory of filename

66 66 setsymbollookup Use of these functions allows the user to specify a set of default parameters for each Symbol to be loaded. Different sources (e.g. yahoo, MySQL, csv), can be specified for each Symbol of interest. The sources must be valid getsymbols methods - see getsymbols for details on which methods are available, as well as how to add additional methods. The argument list to setsymbollookup is simply the unquoted name of the Symbol matched to the desired default source, or list of Symbol specific parameters. For example, to signify that the stock data for Sun Microsystems (JAVA) should be downloaded from Yahoo! Finance, one would call setsymbollookup(java= yahoo ) or setsymbollookup(java=lis It is also possible to specify additional, possibly source specific, lookup details on a per symbol basis. These include an alternate naming convention (useful for sites like Yahoo! where certain non-traded symbols are prepended with a caret, or more correctly a curcumflex accent. In that case one would specify setsymbollookup(dji=list(name="^dji",src="yahoo"))) as well as passed parameters like dbname and password for database sources. See the specific getsymbols function related to the source in question for more details of each implementation. All changes are made to the current list, and will persist only until the end of the session. To always use the same defaults it is necessary to call setsymbollookup with the appropriate parameters from a startup file (e.g..rprofile) or to use savesymbollookup and loadsymbollookup to save and restore lookup tables. To unset a specific Symbol s defaults, simply assign NULL to the Symbol. Called for its side effects, the function changes the options value for the specified Symbol through a call to options(getsymbols.sources=...) Note Changes are NOT persistent across sessions, as the table is stored in the session options by default. This may change to allow for an easier to manage process, as for now it is designed to minimize the clutter created during a typical session. getsymbols, options, setsymbollookup(qqqq='yahoo',dia='mysql') getsymbollookup('qqqq') getsymbollookup(c('qqqq','dia')) ## Will download QQQQ from yahoo ## and load DIA from MySQL getsymbols(c('qqqq','dia'))

67 setta 67 ## Use something like this to always retrieve ## from the same source.first <- function() { require(quantmod,quietly=true) quantmod::setsymbollookup(java="mysql") } ## OR savesymbollookup() loadsymbollookup() setta Manage TA Argument Lists Used to manage the TA arguments used inside chartseries calls. setta(type = c("chartseries", "barchart", "candlechart")) listta(dev) type dev the function to apply defaults TAs to the device to display TA arguments for Note setta and unsetta provide a simple way to reuse the same TA arguments for multiple charts. By default all charting functions will be set to use the current chart s defaults. It is important to note that the current device will be used to extract the list of TA arguments to apply. This is done with a call to listta internally, and followed by calls to setdefaults of the appropriate functions. An additional way to set default TA arguments for subsequent charts is via setdefaults. See the examples. Called for its side-effect of setting the default TA arguments to quantmod s charting functions. Using setdefaults directly will require the vector of default TA calls to be wrapped in a call to substitute to prevent unintended evaluations; OR a call to listta to get the present TA arguments. This last approach is what setta wraps.

68 68 specifymodel chartseries, addta listta() setta() # a longer way to accomplish the same setdefaults(chartseries,ta=listta()) setdefaults(barcart,ta=listta()) setdefaults(candlechart,ta=listta()) setdefaults(chartseries,ta=substitute(c(addvo(),addbbands()))) specifymodel Specify Model Formula For quantmod Process Create a single reusable model specification for subsequent buildmodel calls. An object of class quantmod is created that can be then be reused with different modelling methods and parameters. No data frame is specified, as data is retrieved from potentially multiple environments, and internal calls to getsymbols. specifymodel(formula, na.rm=true) formula na.rm an object of class formula (or one that can be coerced to that class): a symbolic description of the model to be fitted. The details of model specifcation are given under. remove all incomplete rows. Models are specified through the standard formula mechanism. As financial models may include a variety of financial and economic indicators, each differing in source, frequency, and/or class, a single mechanism to specify sources is included within a call to specifymodel. See getmodeldata for details of how this process works. Currently, objects of class quantmod.ohlc, zoo, ts and its are supported within the model formula.

69 trademodel 69 All symbols are first retrieved from the global environment, without inheritence. If an object is not found in the global environment, it is added to a list of objects to load through the getsymbols function. getsymbols retrieves each object specified by using information as to its location specified apriori via setdefaults or setsymbollookup. Internally all data is coerced to zoo,data.frame, or numeric classes. Returns an object of class quantmod. Use modeldata to extract full data set as zoo object. Note It is possible to include any supported series in the formula by simply specifying the object s symbol. See ** for a list of currently supported classes. Use getsymbols.skeleton to create additional methods of data sourcing, e.g. from a proprietary data format or currently unimplemented source (Bloomberg, Oracle). See getsymbols.mysql and getsymbols.yahoo for examples of adding additional functionality Jeffrey Ryan References quantmod.com getmodeldata,getsymbols, buildmodel,trademodel,formula setsymbollookup # if QQQQ is not in the Global environment, an attempt will be made # to retrieve it from the source specified with getsymbols.default specifymodel(next(opcl(qqqq)) ~ Lag(OpHi(QQQQ),0:3) + Hi(DIA)) trademodel Simulate Trading of Fitted quantmod Object Simulated trading of fitted quantmod object. Given a fitted model, trademodel calculates the signal generated over a given historical period, then applies specified trade.rule to calculate and return a tradelog object. Additional methods can then be called to evaluate the performance of the model s strategy.

70 70 trademodel trademodel(x, signal.threshold = c(0, 0), leverage = 1, return.model = TRUE, plot.model = FALSE, trade.dates = NULL, exclude.training = TRUE, ret.type = c("weeks", "months", "quarters", "years"),...) x a quantmod object from buildmodel signal.threshold a numeric vector describing simple lower and upper thresholds before trade occurs leverage amount of leverage to apply - currently a constant return.model should the full model be returned? plot.model trade.dates plot the model? specific trade interval - defaults to full dataset exclude.training exclude the period trained on? ret.type a table of period returns... additional parameters needed by the underlying modelling function, if any Still highly experimental and changing. The purpose is to apply a newly contructed model from buildmodel to a new dataset to investigate the model s trading potential. At present all parameters are very basic. The near term changes include allowing for a trade.rule argument to allow for a dynamic trade rule given a set of signals. Additional the application of variable leverage and costs will become part of the final structure. Any suggestions as to inclusions or alterations are appreciated and should be directed to the maintainer of the package. A quantmodresults object specifymodel buildmodel

71 zoomchart 71 m <- specifymodel(next(opcl(qqqq)) ~ Lag(OpHi(QQQQ))) m.built <- buildmodel(m,method='rpart',training.per=c(' ',' ')) trademodel(m.built) trademodel(m.built,leverage=2) zoomchart Change Zoom Level Of Current Chart Using xts style date subsetting, zoom into or out of the current chart. zooom(n=1, eps=2) zoomchart(subset) n eps subset the number of interactive view changes per call the distance between clicks to be considered a valid subset request a valid subset string These function allow for viewing of specific areas of a chart produced by chartseries by simply specifying the dates of interest zooom is an interactive chart version of zoomchart which utilizes the standard R device interaction tool locator to estimate the subset desired. This estimate is then passed to zoomchart for actual redrawing. At present it is quite experimental in its interface and arguments. Its usage entails a call to zooom() followed by the selection of the leftmost and rightmost points desired in the newly zoomed chart. This selection is accomplished by the user left-clicking each extreme point. Two click are required to determine the level of zooming. Double clicking will reset the chart to the full data range. The arguments and internal working of this function are likely to change dramatically in future releases, though its use will likely remain. Standard format for the subset argument is the same as the subsetting for xts objects, which is how the data is stored internally for rendering. Calling zoomchart with no arguments (NULL) resets the chart to the original data. include 2007 for all of the year 2007, 2007::2008 for years 2007 through 2008, ::2007 for all data from the beginning of the set to the end of 2007, 2007:: all data from the beginning of 2007 through the end of the data. For specifics regarding the level of detail and internal interpretation please see [.xts This function is called for its side effect - notably changing the perspective of the current chart, and changing its formal subset level. The underlying data attached to the chart is left unchanged.

72 72 zoomchart chartseries data(sample_matrix) chartseries(sample_matrix) zoomchart(' ::') zoomchart() zooom() # interactive example

73 Index Topic IO getquote, 36 Topic aplot newta, 56 TA, 7 Topic classes chob-class, 26 chobta-class, 27 quantmod-class, 61 Topic datagen builddata, 19 Lag, 2 Next, 4 Topic datasets getmodeldata, 35 getsymbols.oanda, 48 Topic data getquote, 36 getsymbols, 40 getsymbols.csv, 44 getsymbols.fred, 37 getsymbols.google, 46 getsymbols.mysql, 38 getsymbols.rda, 49 getsymbols.yahoo, 50 modeldata, 54 quantmod.ohlc, 63 Topic dplot newta, 56 Topic hplot newta, 56 Topic misc Lag, 2 Next, 4 Topic models buildmodel, 20 fittedmodel, 28 specifymodel, 67 trademodel, 68 Topic package quantmod-package, 62 Topic ts Lag, 2 Topic utilities addadx, 9 addbbands, 10 addexpiry, 11 addma, 11 addmacd, 13 addroc, 14 addrsi, 15 addsar, 16 addsmi, 17 addvo, 18 addwpr, 18 chartseries, 21 charttheme, 24 Delt, 1 getdividends, 30 getfinancials, 32 getfx, 31 getmetals, 34 getsymbols.sqlite, 43 has.ohlc, 52 internal-quantmod, 53 is.quantmod, 54 modeldata, 54 modelsignal, 55 OHLC.Transformations, 5 options.expiry, 58 periodreturn, 60 setsymbollookup, 64 setta, 66 zoomchart, 70 Ad (OHLC.Transformations), 5 addadx, 9 addatr (TA), 7 addbbands, 10 addcci (TA), 7 addcmf (TA), 7 addcmo (TA), 7 adddema (addma), 11 adddpo (TA), 7 addema (addma), 11 addenvelope (TA), 7 addevwma (addma), 11 73

74 74 INDEX addexpiry, 11, 59 addlines (TA), 7 addma, 11 addmacd, 13 addmomentum (TA), 7 addpoints (TA), 7 addroc, 14 addrsi, 15 addsar, 16 addshading (internal-quantmod), 53 addsma (addma), 11 addsmi, 17 addta, 9 19, 24, 27, 67 addta (newta), 56 addtrix (TA), 7 addvo, 18 addwma (addma), 11 addwpr, 18 addzlema (addma), 11 allreturns (periodreturn), 60 annualreturn (periodreturn), 60 anova.quantmod (fittedmodel), 28 as.quantmod.ohlc (quantmod.ohlc), 63 barchart (chartseries), 21 builddata, 19 buildmodel, 20, 29, 36, 68, 69 candlechart (chartseries), 21 chartseries, 21, 25, 27, 58, 67, 71 chartshading (internal-quantmod), 53 charttheme, 24, 24 chob, 27, 58 chob-class, 26 chobta, 27, 58 chobta-class, 27 Cl (OHLC.Transformations), 5 ClCl (OHLC.Transformations), 5 coef.quantmod (fittedmodel), 28 coefficients.quantmod (fittedmodel), 28 dailyreturn (periodreturn), 60 Delt, 1 dropta (TA), 7 fitted.quantmod (fittedmodel), 28 fitted.values.quantmod (fittedmodel), 28 fittedmodel, 28 fittedmodel<- (fittedmodel), 28 formula, 68 formula.quantmod (fittedmodel), 28 futures.expiry (options.expiry), 58 getdividends, 30 getfin (getfinancials), 32 getfinancials, 32 getfx, 31, 42 getmetals, 34, 42 getmodeldata, 35, 42, 55, 68 getquote, 36 getsymbollookup (setsymbollookup), 64 getsymbols, 20, 24, 31, 32, 35 38, 40, 40, 44, 45, 47, 49 51, 61, 64, 65, 68 getsymbols.csv, 42, 44 getsymbols.fred, 37, 42, 49 getsymbols.google, 42, 46 getsymbols.mysql, 38 getsymbols.mysql (getsymbols.mysql), 38 getsymbols.oanda, 32, 35, 42, 48 getsymbols.rda, 49 getsymbols.rdata, 42 getsymbols.rdata (getsymbols.rda), 49 getsymbols.sqlite, 43 getsymbols.yahoo, 42, 50 has.ad (has.ohlc), 52 has.cl (has.ohlc), 52 has.hi (has.ohlc), 52 has.hlc (has.ohlc), 52 has.lo (has.ohlc), 52 has.ohlc, 52 has.op (has.ohlc), 52 has.vo (has.ohlc), 52 Hi (OHLC.Transformations), 5 HiCl (OHLC.Transformations), 5 HLC (OHLC.Transformations), 5 internal-quantmod, 53 is.hlc (has.ohlc), 52 is.ohlc (has.ohlc), 52 is.quantmod, 54 is.quantmodresults (is.quantmod), 54 Lag, 2, 5 lag, 3 Lag.quantmod.OHLC (Lag), 2 Lag.zoo (Lag), 2

75 INDEX 75 linechart (chartseries), 21 listta (setta), 66 Lo (OHLC.Transformations), 5 load, 50 loadsymbollookup (setsymbollookup), 64 LoCl (OHLC.Transformations), 5 loglik.quantmod (fittedmodel), 28 LoHi (OHLC.Transformations), 5 matchchart (chartseries), 21 modeldata, 20, 36, 54 modelsignal, 55 monthlyreturn (periodreturn), 60 moveta (TA), 7 newta, 56 Next, 4 Next.quantmod.OHLC (Next), 4 Next.zoo (Next), 4 oanda.currencies (getsymbols.oanda), 48 OHLC (OHLC.Transformations), 5 OHLC.Transformations, 5, 53, 64 Op (OHLC.Transformations), 5 OpCl, 2 OpCl (OHLC.Transformations), 5 OpHi (OHLC.Transformations), 5 OpLo (OHLC.Transformations), 5 OpOp, 2 OpOp (OHLC.Transformations), 5 options, 65 options.expiry, 58 periodreturn, 60 plot.quantmod (fittedmodel), 28 savesymbollookup (setsymbollookup), 64 savesymbols (getsymbols), 40 serieshi (OHLC.Transformations), 5 serieslo (OHLC.Transformations), 5 setsymbollookup, 38, 40, 42, 45, 47, 50, 51, 64, 68 setta, 24, 66 show,chobta-method (chobta-class), 27 showsymbols (getsymbols), 40 specifymodel, 5, 7, 20, 21, 36, 40, 42, 54, 55, 67, 69 standardquote (getquote), 36 swapta (TA), 7 TA, 7, 58 to.period, 61 trademodel, 21, 54, 56, 68, 68 unsetsymbollookup (setsymbollookup), 64 unsetta (setta), 66 vcov.quantmod (fittedmodel), 28 viewfin (getfinancials), 32 viewfinancials (getfinancials), 32 Vo (OHLC.Transformations), 5 weeklyreturn (periodreturn), 60 yahooqf (getquote), 36 yearlyreturn (periodreturn), 60 zoom (zoomchart), 70 zoomchart, 70 zooom (zoomchart), 70 quantmod, 29 quantmod (quantmod-package), 62 quantmod-class, 61 quantmod-package, 62 quantmod-show (quantmod-class), 61 quantmod.ohlc, 53, 63 quarterlyreturn (periodreturn), 60 read.csv, 45 rechart (chartseries), 21 removesymbols (getsymbols), 40 resid.quantmod (fittedmodel), 28 residuals.quantmod (fittedmodel), 28