quantstrat (version 0.8.2)

getParameterTable: Extract the parameter structure from a strategy object.

Description

Users can use this function to extract the parameters used in a strategy, and use the output as a reminder/ cheatsheet when they create the parameter distribution or parameter constraints. But it's not required to run to specify the distribution or constraints of parameters.

Usage

getParameterTable(strategy)

Arguments

strategy

The strategy object.

Value

A list of objects that contains the parameter structure information

paramNameList

the list of parameters used in the strategy, for printing or viewing as a table.

strategyName

string name of the strategy

structure

the detailed paramter structure in the input strategy, can be used when user wants to look into more details of the parameter structure.

Examples

# When strategy object stratMACD has already been created by demo macd.R:
# following line will return object x that contains the parameter information.
## Not run: 
# x<-getParameterTable(stratMACD)
# ## End(Not run)