| Title: | Rmetrics - Trading and Rebalancing Financial Instruments | 
| Date: | 2017-11-12 | 
| Version: | 3042.79 | 
| Author: | Diethelm Wuertz [aut], Tobias Setz [cre], Yohan Chalabi [ctb] | 
| Maintainer: | Tobias Setz <tobias.setz@live.com> | 
| Description: | A collection of functions for trading and rebalancing financial instruments. It implements various technical indicators to analyse time series such as moving averages or stochastic oscillators. | 
| Depends: | R (≥ 2.15.1), timeDate, timeSeries, fBasics | 
| Imports: | graphics, stats | 
| Suggests: | methods, RUnit, tcltk | 
| LazyData: | yes | 
| License: | GPL-2 | GPL-3 [expanded from: GPL (≥ 2)] | 
| URL: | http://www.rmetrics.org | 
| NeedsCompilation: | no | 
| Packaged: | 2017-11-15 19:19:22 UTC; Tobias Setz | 
| Repository: | CRAN | 
| Date/Publication: | 2017-11-15 22:37:38 UTC | 
Trading and Rebalancing Financial Instruments
Description
The Rmetrics "fTrading" package is a collection of functions for trading and rebalancing financial instruments.
Details
| Package: | fTrading | 
| Type: | Package | 
| Version: | R 3.0.1 | 
| Date: | 2014 | 
| License: | GPL Version 2 or later | 
| Copyright: | (c) 1999-2014 Rmetrics Association | 
| Repository: | R-FORGE | 
| URL: | https://www.rmetrics.org | 
Content
Utility Functions:
    emaTA           Exponential Moving Average
    biasTA          Bias Indicator
    medpriceTA      Medium Price Indicator
    typicalpriceTA  Typical Price Indicator
    wcloseTA        Weighted Close Indicator
    rocTA           Rate of Change
    oscTA           Oscillator Indicator
    
Oscillator Indicators:
    momTA           Momentum Indicator
    macdTA          MACD Indicator
    cdsTA           MACD Signal Line
    cdoTA           MACD Oscillator
    vohlTA          High/Low Volatility
    vorTA           Volatility Ratio
    
    stochasticTA    Stochastics Oscillator
    fpkTA           Fast Percent K
    fpdTA           Fast Percent D
    spdTA           Slow Percent D
    apdTA           Averaged Percent D
    wprTA           William's Percent R
    rsiTA           Relative Strength Index
    
S-Plus Like Moving Averages:
    SMA             Simple Moving Average
    EWMA            Exponentially Weighted  Moving Average
    
About Rmetrics:
The fTrading Rmetrics package is written for educational 
support in teaching "Computational Finance and Financial Engineering" 
and licensed under the GPL.
Utilities and Benchmark Analysis
Description
A collection and description of utility 
and benchmark functions for the analysis 
of financial markets. The collection 
provides a set of functions for the 
computation of returns, for the display 
of price charts, and for benchmark 
measurements.
The functions are:
| ohlcPlot | Plots open--high--low--close bar charts, | 
| sharpeRatio | Computes Sharpe Ratio, | 
| sterlingRatio | Computes Sterling Ratio, | 
| maxDrawDown | Computes maximum drawdown. | 
Usage
ohlcPlot(x, xlim = NULL, ylim = NULL, xlab = "Time", ylab, col = par("col"),
    bg = par("bg"), axes = TRUE, frame.plot = axes, ann = par("ann"),
    main = NULL, date = c("calendar", "julian"), format = "%Y-%m-%d",
    origin = "1899-12-30", ...)
    
sharpeRatio(x, r = 0, scale = sqrt(250))
sterlingRatio(x)
maxDrawDown(x)
Arguments
| date,format,origin | [ohlcPlot] -  | 
| r | [sharpeRatio] -  | 
| scale | [sharpeRatio] -  | 
| x | a numeric vector of prices.
For  | 
| xlim,ylim,xlab,ylab,col,bg,axes,frame.plot,ann,main | [ohlcPlot] -  | 
| ... | [ohlcPlot] -  | 
Details
Open–High–Low–Close Chart:
Within an open–high–low–close bar chart, each bar represents
price information for the time interval between the open and the close
price. The left tick for each bar indicates the open price for the
time interval. The right tick indicates the closing price for the time
interval. The vertical length of the bar represents the price range
for the time interval.
The time scale of x must be in Julian dates (days since the
origin).
[tseries:plotOHLC]
Sharpe and Sterling Ratios:
  
The Sharpe ratio is defined as a portfolio's mean return in excess of
the riskless return divided by the portfolio's standard deviation. In
finance the Sharpe Ratio represents a measure of the portfolio's
risk-adjusted (excess) return. 
The Sterling ratio is defined as a portfolio's overall return divided
by the portfolio's maximum drawdown statistic. In finance the
Sterling Ratio represents a measure of the portfolio's risk-adjusted
return.
[tseries:sharpe]
  
Maximum Drawdown:
The maximum drawdown or maximum loss statistic is defined as the 
maximum value drop after one of the peaks of x. For financial
instruments the maximum drawdown represents the worst investment 
loss for a buy–and–hold strategy invested in x.
[tseries:maxdrawdown]
Get Returns:
The function computes the return series given a financial security 
price series. The price series may be an object of class numeric
or a time series object. This includes objects of classes "ts",
"its" and/or "timeSeries".
Value
ohlcPlot 
creates an Open–High–Low–Close chart.
sharpeRatio
sterlingRatio 
return the Sharpe or Sterling ratio, a numeric value.
maxDrawDown
returns a list containing the following three components: 
maxDrawDown, double representing the max drawdown or max loss 
statistic; from, the index (or vector of indices) where the 
maximum drawdown period starts; to, the index (or vector of 
indices) where the max drawdown period ends.
Author(s)
Adrian Trapletti for the ohlcPlot,*Ratio and maxDrawDown functions, 
Diethelm Wuertz for the Rmetrics R-port.
Examples
## ohlcPlot -
   # Plot OHLC for SP500
   # ohlcPlot(x, ylab = "price", main = instrument)
   
## sharpeRatio -
   # Sharpe Ratio for DAX and FTSE:
   data(EuStockMarkets)
   dax = log(EuStockMarkets[, "DAX"])
   ftse = log(EuStockMarkets[, "FTSE"])
   # Ratios:
   sharpeRatio(dax)
   sharpeRatio(ftse)
   
## maxDrawDown -
   data(EuStockMarkets)
   dax = log(EuStockMarkets[, "DAX"])
   mdd = maxDrawDown(dax)
   mdd
   # Plot DAX:
   plot(dax)
   grid()
   segments(time(dax)[mdd$from], dax[mdd$from],
     time(dax)[mdd$to], dax[mdd$from])
   segments(time(dax)[mdd$from], dax[mdd$to],
     time(dax)[mdd$to], dax[mdd$to])
   mid = time(dax)[(mdd$from + mdd$to)/2]
   arrows(mid, dax[mdd$from], mid, dax[mdd$to], col = 2)
   title(main = "DAX: Max Drawdown")
Rolling Analysis
Description
A collection and description of functions
to perform a rolling analysis. A rolling
analysis is often required in building
trading models.
The functions are:
| rollFun | Rolling or moving sample statistics, | 
| rollVar | Rolling or moving sample variance. | 
Usage
rollFun(x, n, trim = TRUE, na.rm = FALSE, FUN, ...)
rollVar(x, n = 9, trim = TRUE, unbiased = TRUE, na.rm = FALSE)
Arguments
| FUN | the rolling function, arguments to this function can be
passed through the  | 
| n | an integer specifying the number of periods or terms to use in each rolling/moving sample. | 
| na.rm | a logical flag: if TRUE, missing values in x will be removed before computation. The default is FALSE. | 
| trim | a logical flag: if TRUE, the first n-1 missing values in the returned object will be removed; if FALSE, they will be saved in the returned object. The default is TRUE. | 
| unbiased | a logical flag. If TRUE, the unbiased sample variance will be returned. The default is TRUE. | 
| x | an univariate  | 
| ... | additional arguments to be passed. | 
Value
The functions return a timeSeries object or a numeric
vector, depending on the argument x.
rollMax returns the rolling sample maximum, 
rollMin returns the rolling sample minimum, 
rollMean returns the rolling sample mean, and 
rollVar returns the biased/unbiased rolling sample variance.
Note, that the function rollFun always returns a numeric
vector, independent of the argument x.
If you like to operate for x with rectangular objects,
you have to call the functions columnwise within a loop.
Author(s)
Diethelm Wuertz for the Rmetrics R-port.
See Also
var.
Examples
## Rolling Analysis:
   x = (1:10)^2
   x
   trim =  c(TRUE, TRUE, FALSE, FALSE)
   na.rm = c(TRUE, FALSE, TRUE, FALSE)
   for (i in 1:4)
     rollFun(x, 5, trim[i], na.rm[i], FUN = min)
   for (i in 1:4)
     rollFun(x, 5, trim[i], na.rm[i], FUN = max)
   for (i in 1:4)
     rollVar(x, 5, trim[i], unbiased = TRUE, na.rm[i])
   for (i in 1:4)
     rollVar(x, 5, trim[i], unbiased = FALSE, na.rm[i])
Tools for the Technical Analysis
Description
A collection and description of functions 
for the technical analysis of stock markets. 
The collection provides a set of the most 
common technical indicators.
Utility Functions:
| emaTA | Exponential Moving Average, | 
| biasTA | Bias Indicator, | 
| medpriceTA | Medium Price Indicator, | 
| typicalpriceTA | Typical Price Indicator, | 
| wcloseTA | Weighted Close Indicator, | 
| rocTA | Rate of Change, | 
| oscTA | Oscillator Indicator. | 
Oscillator Indicators:
| momTA | Momentum Indicator, | 
| macdTA | MACD Indicator, | 
| cdsTA | MACD Signal Line, | 
| cdoTA | MACD Oscillator, | 
| vohlTA | High/Low Volatility, | 
| vorTA | Volatility Ratio. | 
| stochasticTA | Stochastics Oscillator, | 
| fpkTA | Fast Percent K, | 
| fpdTA | Fast Percent D, | 
| spdTA | Slow Percent D, | 
| apdTA | Averaged Percent D, | 
| wprTA | William's Percent R, | 
| rsiTA | Relative Strength Index. | 
S-Plus Like Moving Averages:
| SMA | Simple Moving Average, | 
| EWMA | Exponentially Weighted Moving Average. | 
Usage
emaTA(x, lambda, startup = 0)
biasTA(x, lag)
medpriceTA(high, low)
typicalpriceTA(high, low, close)
wcloseTA(high, low, close)
rocTA(x, lag)
oscTA(x, lag1 = 25, lag2 = 65)
momTA(x, lag)
macdTA(x, lag1, lag2)
cdsTA(x, lag1 = 12, lag2 = 26, lag3 = 9)
cdoTA(x, lag1 = 12, lag2 = 26, lag3 = 9)
vohlTA(high, low)
vorTA(high, low)
stochasticTA(close, high, low, lag1 = 5, lag2 = 3, lag3 = 5, 
    type = c("fast", "slow")) 
fpkTA(close, high, low, lag)
fpdTA(close, high, low, lag1, lag2)
spdTA(close, high, low, lag1, lag2, lag3)
apdTA(close, high, low, lag1, lag2, lag3, lag4)
wprTA(close, high, low, lag)
rsiTA(close, lag)
SMA(x, n = 5)
EWMA(x, lambda, startup = 0)
Arguments
| lag,lag1,lag2,lag3,lag4 | integer values, time lags. | 
| n | [SMA] -  | 
| lambda | [emaTA][EWMA] -  | 
| startup | [emaTA][EWMA] -  | 
| type | [stochasticTA] -  | 
| x,high,low,close | a numeric vector of prices, either opening, closing, or
high and low values.
For  | 
Value
*TA
 
The technical Indicators return the following numeric vectors (or matrix):
emaTA returns the Exponential Moving Average, EMA 
biasTA returns the EMA-Bias, 
medpriceTA returns the Medium Price, 
typicalpriceTA returns the Typical Price, 
wcloseTA returns the Weighted Closing Price, 
rocTA returns the Rate of Change Indicator, 
oscTA returns the EMA Oscillator Indicator, 
momTA returns the Momentum Oscillator, 
macdTA returns the MACD Oscillator, 
cdsTA returns the MACD Signal Line, 
cdo returns the MACD Oscillator, 
vohlTA returns the High/Low Volatility Oscillator, 
vorTA returns Volatility Ratio Oscillator, 
stochasticTA returns a 2-column matrix with percent K and D Indicator, 
fpkTA returns the Fast Percent-K Stochastics Indicator, 
fpdTA returns the Fast Percent-D Stochastics Indicator, 
spdTA returns the Slow Percent-D Stochastics Indicator, 
apdTA returns the Averaged Percent-D Stochastics Indicator, 
wprTA returns the Williams Percent-R Stochastics Indicator, 
rsiTA returns the Relative Strength Index Stochastics Indicator. 
Author(s)
Diethelm Wuertz for the Rmetrics R-port.
Examples
## data -
   # Load MSFT Data:
   x = MSFT
   colnames(x)
   x = x[, "Close"]
   head(x)
   
## emaTA -
   # Exponential Moving Average:
   y = emaTA(x, lambda = 9)   
   seriesPlot(x)
   lines(y, col = "red")