createOptimalStatisticTimeSeries: extract optimization statistics from the optimization object

Description Usage Arguments Value Examples

Description

extract optimization statistics from the optimization object

Usage

1
2
3
createOptimalStatisticTimeSeries(optimizationResultsObject, statisticType,
  datePeriodType = "train", annualize = FALSE, indexType = "timeSeries",
  indexTimeSeriesFreq = "daily")

Arguments

optimizationResultsObject

a list containing rolling statistics for an optimization

statisticType

character string, one of "opHoldings", "opWeights", "opER", "opSD", "opSharpe", "opIndex" for Optimal result; one of "mvHoldings", "mvWeights", "mvER", "mvSD", "mvSharpe", "mvIndex" for Minimum Variance result; or for a list of Efficient Fronter numbers, "ER" for expected return, "SD" for standard deviation, and "EF" for a list of matrices where the first column is standard deviation, and second column is expected return

datePeriodType

character string, one of "train", "test", currently assumes one month ahead, defaults to "train"

annualize

logical that will annualize Expected Return, Standard Deviation or Sharpe ratio, if it's not applicable, it will be ignored; defaults to FALSE

indexType

character string, one of "timeSeries" or "raw"; where "timeSeries" generates a daily xts object of the statistic, and "raw" appends the rolling time period to the statistic

indexTimeSeriesFreq

character string, one of "daily", "weekly", "monthly", or "yearly"; only applicable if indexType = "timeSeries", defaults to "daily"

Value

an xts matrix of results OR a list of matrices depending on the selection

Examples

1
FUNCTION STILL UNDER DEVELOPMENT

erolbicero/propfolio documentation built on May 16, 2019, 8:48 a.m.