residualizeReturns | R Documentation |
#' function to Residualize the returns via regressions
residualizeReturns(specObj, benchmark, rfRate, isBenchExcess = FALSE)
specObj |
specObj is a ffmSpec object, |
benchmark |
we might need market returns |
rfRate |
risk free rate |
isBenchExcess |
toggle to select whether to calculate excess returns |
this function operates on the data inside the specObj and residualizes the returns to create residual return using regressions of returns on a benchmark.
the ffmSpec object with resturns residualized
specFfm
for information on the definition of the specFfm object.
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.