getStratName: Get strategy function name from 'Strategy'-object

Description Usage Arguments Examples

Description

Gets the strategy function name of an object of class Strategy that was used for strategy calculation. This function is for aesthetic purposes only and does not have any numerical relevance.

Usage

1
2
3
4
getStratName(object, include.params = FALSE)

## S4 method for signature 'Strategy'
getStratName(object, include.params = FALSE)

Arguments

object

An object of class Strategy.

include.params

If set to TRUE, the parameters used for strategy evaluation are included.

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
##Not run:

# MA(200)-Strategy
params <- list(k=200)
myStrat.MA <- Strategy(assets=assets, strat="MA", strat.params=params)

# Get strategy function name from MA(200)-Strategy
getStratName(myStrat.MA) # returns "MA"
getStratName(myStrat.MA, include.params=TRUE) # returns "MA(200)"

##End(Not run)

Strategy documentation built on May 2, 2019, 2:09 a.m.