[Returnanalytics-commits] r3065 - in pkg/FactorAnalytics: R man
noreply at r-forge.r-project.org
noreply at r-forge.r-project.org
Thu Sep 12 00:05:46 CEST 2013
Author: chenyian
Date: 2013-09-12 00:05:46 +0200 (Thu, 12 Sep 2013)
New Revision: 3065
Modified:
pkg/FactorAnalytics/R/predict.FundamentalFactorModel.r
pkg/FactorAnalytics/R/predict.StatFactorModel.r
pkg/FactorAnalytics/R/predict.TimeSeriesFactorModel.r
pkg/FactorAnalytics/R/print.FM.attribution.r
pkg/FactorAnalytics/R/print.FundamentalFactorModel.r
pkg/FactorAnalytics/R/print.StatFactorModel.r
pkg/FactorAnalytics/R/print.TimeSeriesFactorModel.r
pkg/FactorAnalytics/R/rCornishFisher.R
pkg/FactorAnalytics/R/summary.FM.attribution.r
pkg/FactorAnalytics/R/summary.FundamentalFactorModel.r
pkg/FactorAnalytics/R/summary.StatFactorModel.r
pkg/FactorAnalytics/R/summary.TimeSeriesFactorModel.r
pkg/FactorAnalytics/man/CornishFisher.Rd
pkg/FactorAnalytics/man/predict.FundamentalFactorModel.Rd
pkg/FactorAnalytics/man/predict.StatFactorModel.Rd
pkg/FactorAnalytics/man/predict.TimeSeriesFactorModel.Rd
pkg/FactorAnalytics/man/print.FM.attribution.Rd
pkg/FactorAnalytics/man/print.FundamentalFactorModel.Rd
pkg/FactorAnalytics/man/print.StatFactorModel.Rd
pkg/FactorAnalytics/man/print.TimeSeriesFactorModel.Rd
pkg/FactorAnalytics/man/summary.FM.attribution.Rd
pkg/FactorAnalytics/man/summary.FundamentalFactorModel.Rd
pkg/FactorAnalytics/man/summary.StatFactorModel.Rd
pkg/FactorAnalytics/man/summary.TimeSeriesFactorModel.Rd
Log:
improving documentation for predit, print, summary methods
Modified: pkg/FactorAnalytics/R/predict.FundamentalFactorModel.r
===================================================================
--- pkg/FactorAnalytics/R/predict.FundamentalFactorModel.r 2013-09-11 21:31:25 UTC (rev 3064)
+++ pkg/FactorAnalytics/R/predict.FundamentalFactorModel.r 2013-09-11 22:05:46 UTC (rev 3065)
@@ -2,14 +2,14 @@
#'
#' Generic function of predict method for fitFundamentalFactorModel.
#'
-#' newdata must be data.frame and contians date variable, asset variable and exact
+#' \code{newdata} must be data.frame and contain date variable, asset variable and exact
#' exposures names that are used in fit object by \code{fitFundamentalFactorModel}
#'
#' @param object fit "FundamentalFactorModel" object
#' @param newdata An optional data frame in which to look for variables with which to predict.
#' If omitted, the fitted values are used.
-#' @param new.assetvar specify new asset variable in newdata if newdata is provided.
-#' @param new.datevar speficy new date variable in newdata if newdata is provided.
+#' @param new.assetvar Specify new asset variable in newdata if newdata is provided.
+#' @param new.datevar Speficy new date variable in newdata if newdata is provided.
#' @method predict FundamentalFactorModel
#' @export
#' @author Yi-An Chen
Modified: pkg/FactorAnalytics/R/predict.StatFactorModel.r
===================================================================
--- pkg/FactorAnalytics/R/predict.StatFactorModel.r 2013-09-11 21:31:25 UTC (rev 3064)
+++ pkg/FactorAnalytics/R/predict.StatFactorModel.r 2013-09-11 22:05:46 UTC (rev 3065)
@@ -4,8 +4,9 @@
#' function \code{predict.lm}.
#'
#' @param object A fit object created by fitStatisticalFactorModel.
-#' @param newdata a vector, matrix, data.frame, xts, timeSeries or zoo object to be coerced.
-#' @param ... Any other arguments used in \code{predict.lm}. For example like newdata and fit.se.
+#' @param newdata A vector, matrix, data.frame, xts, timeSeries or zoo object to be coerced.
+#' @param ... Any other arguments used in \code{predict.lm}, such as \code{newdata} and
+#' \code{fit.se}.
#' @author Yi-An Chen.
#' @method predict StatFactorModel
#' @export
Modified: pkg/FactorAnalytics/R/predict.TimeSeriesFactorModel.r
===================================================================
--- pkg/FactorAnalytics/R/predict.TimeSeriesFactorModel.r 2013-09-11 21:31:25 UTC (rev 3064)
+++ pkg/FactorAnalytics/R/predict.TimeSeriesFactorModel.r 2013-09-11 22:05:46 UTC (rev 3065)
@@ -4,8 +4,9 @@
#' function \code{predict.lm}.
#'
#' @param object A fit object created by fitTimeSeiresFactorModel.
-#' @param newdata a vector, matrix, data.frame, xts, timeSeries or zoo object to be coerced.
-#' @param ... Any other arguments used in \code{predict.lm}. for example newdata and se.fit.
+#' @param newdata A vector, matrix, data.frame, xts, timeSeries or zoo object to be coerced.
+#' @param ... Any other arguments used in \code{predict.lm}, such as \code{newdata} and
+#' \code{fit.se}.
#' @author Yi-An Chen.
#'
#' @examples
Modified: pkg/FactorAnalytics/R/print.FM.attribution.r
===================================================================
--- pkg/FactorAnalytics/R/print.FM.attribution.r 2013-09-11 21:31:25 UTC (rev 3064)
+++ pkg/FactorAnalytics/R/print.FM.attribution.r 2013-09-11 22:05:46 UTC (rev 3065)
@@ -1,10 +1,10 @@
#' Print FM.attribution object.
#'
-#' Generic function of print method for factorModelPerformanceAttribution.
+#' Generic function of print method for \code{factorModelPerformanceAttribution}.
#'
#'
#' @param fm.attr FM.attribution object created by
-#' factorModelPerformanceAttribution.
+#' \code{factorModelPerformanceAttribution}.
#' @author Yi-An Chen.
#' @examples
#' \dontrun{
Modified: pkg/FactorAnalytics/R/print.FundamentalFactorModel.r
===================================================================
--- pkg/FactorAnalytics/R/print.FundamentalFactorModel.r 2013-09-11 21:31:25 UTC (rev 3064)
+++ pkg/FactorAnalytics/R/print.FundamentalFactorModel.r 2013-09-11 22:05:46 UTC (rev 3065)
@@ -1,11 +1,11 @@
#' print FundamentalFactorModel object
#'
-#' Generic function of print method for fitFundamentalFactorModel.
+#' Generic function of print method for \code{fitFundamentalFactorModel}.
#'
#'
-#' @param x fit object created by fitFundamentalFactorModel.
-#' @param digits integer indicating the number of decimal places. Default is 3.
-#' @param ... Other arguments for print methods.
+#' @param x Fit object created by fitFundamentalFactorModel.
+#' @param digits Integer indicating the number of decimal places. Default is 3.
+#' @param ... Other arguments for \code{print} methods.
#' @author Yi-An Chen.
#' @method print FundamentalFactorModel
#' @export
Modified: pkg/FactorAnalytics/R/print.StatFactorModel.r
===================================================================
--- pkg/FactorAnalytics/R/print.StatFactorModel.r 2013-09-11 21:31:25 UTC (rev 3064)
+++ pkg/FactorAnalytics/R/print.StatFactorModel.r 2013-09-11 22:05:46 UTC (rev 3065)
@@ -1,11 +1,11 @@
#' print StatFactorModel object
#'
-#' Generic function of print method for fitStatFactorModel.
+#' Generic function of print method for \code{fitStatFactorModel}.
#'
#'
-#' @param x fit object created by fitStatisticalFactorModel.
-#' @param digits integer indicating the number of decimal places. Default is 3.
-#' @param ... Other arguments for print methods.
+#' @param x Fit object created by \code{fitStatisticalFactorModel}.
+#' @param digits Integer indicating the number of decimal places. Default is 3.
+#' @param ... Other arguments for \code{print} methods.
#' @author Eric Zivot and Yi-An Chen.
#' @examples
#'
Modified: pkg/FactorAnalytics/R/print.TimeSeriesFactorModel.r
===================================================================
--- pkg/FactorAnalytics/R/print.TimeSeriesFactorModel.r 2013-09-11 21:31:25 UTC (rev 3064)
+++ pkg/FactorAnalytics/R/print.TimeSeriesFactorModel.r 2013-09-11 22:05:46 UTC (rev 3065)
@@ -1,11 +1,11 @@
#' print TimeSeriesfactorModel object
#'
-#' Generic function of print method for fitTimeSeriesFactorModel.
+#' Generic function of print method for \code{fitTimeSeriesFactorModel}.
#'
#'
-#' @param x fit object created by fitTimeSeriesFactorModel.
-#' @param digits integer indicating the number of decimal places. Default is 3.
-#' @param ... arguments to be passed to print method.
+#' @param x Fit object created by \code{fitTimeSeriesFactorModel}.
+#' @param digits Integer indicating the number of decimal places. Default is 3.
+#' @param ... Other arguments for \code{print} methods.
#' @author Yi-An Chen.
#' @method print TimeSeriesFactorModel
#' @export
Modified: pkg/FactorAnalytics/R/rCornishFisher.R
===================================================================
--- pkg/FactorAnalytics/R/rCornishFisher.R 2013-09-11 21:31:25 UTC (rev 3064)
+++ pkg/FactorAnalytics/R/rCornishFisher.R 2013-09-11 22:05:46 UTC (rev 3065)
@@ -25,19 +25,19 @@
#' deviation, skewness and excess kurtosis.
#'}
#'
-#'@param n scalar, number of simulated values in rCornishFisher. Sample length in
+#'@param n Scalar, number of simulated values in rCornishFisher. Sample length in
#' density,distribution,quantile function.
-#' @param sigma scalar, standard deviation.
-#' @param skew scalar, skewness.
-#' @param ekurt scalar, excess kurtosis.
-#' @param seed set seed here. Default is \code{NULL}.
-#' @param x,q vector of standardized quantiles. See detail.
-#' @param p vector of probabilities.
+#' @param sigma Scalar, standard deviation.
+#' @param skew Scalar, skewness.
+#' @param ekurt Scalar, excess kurtosis.
+#' @param seed Set seed here. Default is \code{NULL}.
+#' @param x,q Vector of standardized quantiles. See detail.
+#' @param p Vector of probabilities.
#'
-#' @return n simulated values from Cornish-Fisher distribution.
+#' @return n Simulated values from Cornish-Fisher distribution.
#' @author Eric Zivot and Yi-An Chen.
#' @references
-#' \itemize{
+#' \enumerate{
#' \item A.DasGupta, "Asymptotic Theory of Statistics and
#' Probability", Springer Science+Business Media,LLC 2008
#' \item Thomas A.Severini, "Likelihood Methods in Statistics",
Modified: pkg/FactorAnalytics/R/summary.FM.attribution.r
===================================================================
--- pkg/FactorAnalytics/R/summary.FM.attribution.r 2013-09-11 21:31:25 UTC (rev 3064)
+++ pkg/FactorAnalytics/R/summary.FM.attribution.r 2013-09-11 22:05:46 UTC (rev 3065)
@@ -1,10 +1,12 @@
#' summary FM.attribution object.
#'
-#' Generic function of summary method for factorModelPerformanceAttribution.
+#' Generic function of summary method for \code{factorModelPerformanceAttribution}.
#'
#'
#' @param fm.attr FM.attribution object created by
-#' factorModelPerformanceAttribution.
+#' \code{factorModelPerformanceAttribution}.
+#' @param digits integer indicating the number of decimal places. Default is 3.
+#' @param ... Other arguments for \code{print} methods.
#' @author Yi-An Chen.
#' @examples
#' # load data from the database
@@ -19,14 +21,14 @@
#' @method summary FM.attribution
#' @export
#'
-summary.FM.attribution <- function(fm.attr) {
+summary.FM.attribution <- function(fm.attr,digits = max(3, .Options$digits - 3),...) {
# n <- dim(fm.attr[[1]])[1]
# k <- dim(fm.attr[[1]])[2]+1
# table.mat <- matrix(rep(NA,n*k*2),ncol=n)
cat("\nMean of returns attributed to factors
\n")
- print(sapply(fm.attr[[3]],function(x) apply(x,2,mean)))
+ print(sapply(fm.attr[[3]],function(x) apply(x,2,mean)),digits = digits,...)
cat("\nStandard Deviation of returns attributed to factors
\n")
- print(sapply(fm.attr[[3]],function(x) apply(x,2,sd)))
+ print(sapply(fm.attr[[3]],function(x) apply(x,2,sd)),digits = digits,...)
}
Modified: pkg/FactorAnalytics/R/summary.FundamentalFactorModel.r
===================================================================
--- pkg/FactorAnalytics/R/summary.FundamentalFactorModel.r 2013-09-11 21:31:25 UTC (rev 3064)
+++ pkg/FactorAnalytics/R/summary.FundamentalFactorModel.r 2013-09-11 22:05:46 UTC (rev 3065)
@@ -1,11 +1,11 @@
#' summary FundamentalFactorModel object
#'
-#' Generic function of summary method for fitFundamentalFactorModel.
+#' Generic function of summary method for \code{fitFundamentalFactorModel}.
#'
#'
-#' @param object An object created by fitFundamentalFactorModel.
+#' @param object An object created by \code{fitFundamentalFactorModel}.
#' @param digits integer indicating the number of decimal places. Default is 3.
-#' @param ... Other arguments for print methods.
+#' @param ... Other arguments for \code{print} methods.
#' @author Yi-An Chen.
#' @method summary FundamentalFactorModel
#' @export
Modified: pkg/FactorAnalytics/R/summary.StatFactorModel.r
===================================================================
--- pkg/FactorAnalytics/R/summary.StatFactorModel.r 2013-09-11 21:31:25 UTC (rev 3064)
+++ pkg/FactorAnalytics/R/summary.StatFactorModel.r 2013-09-11 22:05:46 UTC (rev 3065)
@@ -1,11 +1,11 @@
#' summary method for StatFactorModel object.
#'
-#' Generic function of summary method for fitStatisticalFactorModel.
+#' Generic function of summary method for \code{fitStatisticalFactorModel}.
#'
#'
-#' @param object An Object created by fitStatisticalFactorModel.
-#' @param digits Integer indicating the number of decimal places. Default is 3.
-#' @param ... other option used in \code{summary.lm}
+#' @param object An Object created by \code{fitStatisticalFactorModel}.
+#' @param digits Integer indicates the number of decimal places. Default is 3.
+#' @param ... other option used in \code{print} method.
#' @author Yi-An Chen.
#' @method summary StatFactorModel
#' @export
@@ -18,7 +18,7 @@
#' summary(fit)
#'
#'
-summary.StatFactorModel <- function(object,digits=3){
+summary.StatFactorModel <- function(object,digits=3,...){
if(!is.null(cl <- object$call)) {
cat("\nCall:\n")
dput(cl)
@@ -30,7 +30,7 @@
cat("\n", object$assets.names[i], "\n")
table.macro <- t(summary(object$asset.fit[[i]])$coefficients)
colnames(table.macro)[1] <- "alpha"
- print(table.macro,digits = digits)
+ print(table.macro,digits = digits,...)
cat("\nR-square =", object$r2[i] ,",residual variance ="
, object$resid.variance[i],"\n")
}
Modified: pkg/FactorAnalytics/R/summary.TimeSeriesFactorModel.r
===================================================================
--- pkg/FactorAnalytics/R/summary.TimeSeriesFactorModel.r 2013-09-11 21:31:25 UTC (rev 3064)
+++ pkg/FactorAnalytics/R/summary.TimeSeriesFactorModel.r 2013-09-11 22:05:46 UTC (rev 3065)
@@ -1,11 +1,11 @@
#' summary method for TimeSeriesModel object.
#'
-#' Generic function of summary method for fitTimeSeriesFactorModel.
+#' Generic function of summary method for \code{fitTimeSeriesFactorModel}.
#'
#'
-#' @param object An object created by fitTimeSeiresFactorModel.
-#' @param digits Integer indicating the number of decimal places. Default is 3.
-#' @param ... other option used in \code{summary.lm}
+#' @param object An object created by \code{fitTimeSeiresFactorModel}.
+#' @param digits Integer indicates the number of decimal places. Default is 3.
+#' @param ... Other option used in \code{print} method.
#' @author Yi-An Chen.
#' @examples
#'
@@ -19,7 +19,7 @@
#' @method summary TimeSeriesFactorModel
#' @export
#'
-summary.TimeSeriesFactorModel <- function(object,digits=3){
+summary.TimeSeriesFactorModel <- function(object,digits=3,...){
if(!is.null(cl <- object$call)) {
cat("\nCall:\n")
dput(cl)
@@ -31,7 +31,7 @@
cat("\n", object$assets.names[i], "\n")
table.macro <- t(summary(object$asset.fit[[i]])$coefficients)
colnames(table.macro)[1] <- "alpha"
- print(table.macro,digits = digits)
+ print(table.macro,digits = digits,...)
cat("\nR-square =", object$r2[i] ,",residual variance ="
, object$resid.variance[i],"\n")
}
Modified: pkg/FactorAnalytics/man/CornishFisher.Rd
===================================================================
--- pkg/FactorAnalytics/man/CornishFisher.Rd 2013-09-11 21:31:25 UTC (rev 3064)
+++ pkg/FactorAnalytics/man/CornishFisher.Rd 2013-09-11 22:05:46 UTC (rev 3065)
@@ -16,24 +16,24 @@
rCornishFisher(n, sigma, skew, ekurt, seed = NULL)
}
\arguments{
- \item{n}{scalar, number of simulated values in
+ \item{n}{Scalar, number of simulated values in
rCornishFisher. Sample length in
density,distribution,quantile function.}
- \item{sigma}{scalar, standard deviation.}
+ \item{sigma}{Scalar, standard deviation.}
- \item{skew}{scalar, skewness.}
+ \item{skew}{Scalar, skewness.}
- \item{ekurt}{scalar, excess kurtosis.}
+ \item{ekurt}{Scalar, excess kurtosis.}
- \item{seed}{set seed here. Default is \code{NULL}.}
+ \item{seed}{Set seed here. Default is \code{NULL}.}
- \item{x,q}{vector of standardized quantiles. See detail.}
+ \item{x,q}{Vector of standardized quantiles. See detail.}
- \item{p}{vector of probabilities.}
+ \item{p}{Vector of probabilities.}
}
\value{
- n simulated values from Cornish-Fisher distribution.
+ n Simulated values from Cornish-Fisher distribution.
}
\description{
\itemize{ \item \code{rCornishFisher} simulate
@@ -78,7 +78,7 @@
Eric Zivot and Yi-An Chen.
}
\references{
- \itemize{ \item A.DasGupta, "Asymptotic Theory of
+ \enumerate{ \item A.DasGupta, "Asymptotic Theory of
Statistics and Probability", Springer Science+Business
Media,LLC 2008 \item Thomas A.Severini, "Likelihood
Methods in Statistics", Oxford University Press, 2000 }
Modified: pkg/FactorAnalytics/man/predict.FundamentalFactorModel.Rd
===================================================================
--- pkg/FactorAnalytics/man/predict.FundamentalFactorModel.Rd 2013-09-11 21:31:25 UTC (rev 3064)
+++ pkg/FactorAnalytics/man/predict.FundamentalFactorModel.Rd 2013-09-11 22:05:46 UTC (rev 3065)
@@ -12,10 +12,10 @@
for variables with which to predict. If omitted, the
fitted values are used.}
- \item{new.assetvar}{specify new asset variable in newdata
+ \item{new.assetvar}{Specify new asset variable in newdata
if newdata is provided.}
- \item{new.datevar}{speficy new date variable in newdata
+ \item{new.datevar}{Speficy new date variable in newdata
if newdata is provided.}
}
\description{
@@ -23,9 +23,10 @@
fitFundamentalFactorModel.
}
\details{
- newdata must be data.frame and contians date variable,
- asset variable and exact exposures names that are used in
- fit object by \code{fitFundamentalFactorModel}
+ \code{newdata} must be data.frame and contain date
+ variable, asset variable and exact exposures names that
+ are used in fit object by
+ \code{fitFundamentalFactorModel}
}
\examples{
data(Stock.df)
Modified: pkg/FactorAnalytics/man/predict.StatFactorModel.Rd
===================================================================
--- pkg/FactorAnalytics/man/predict.StatFactorModel.Rd 2013-09-11 21:31:25 UTC (rev 3064)
+++ pkg/FactorAnalytics/man/predict.StatFactorModel.Rd 2013-09-11 22:05:46 UTC (rev 3065)
@@ -9,11 +9,11 @@
\item{object}{A fit object created by
fitStatisticalFactorModel.}
- \item{newdata}{a vector, matrix, data.frame, xts,
+ \item{newdata}{A vector, matrix, data.frame, xts,
timeSeries or zoo object to be coerced.}
- \item{...}{Any other arguments used in \code{predict.lm}.
- For example like newdata and fit.se.}
+ \item{...}{Any other arguments used in \code{predict.lm},
+ such as \code{newdata} and \code{fit.se}.}
}
\description{
Generic function of predict method for
Modified: pkg/FactorAnalytics/man/predict.TimeSeriesFactorModel.Rd
===================================================================
--- pkg/FactorAnalytics/man/predict.TimeSeriesFactorModel.Rd 2013-09-11 21:31:25 UTC (rev 3064)
+++ pkg/FactorAnalytics/man/predict.TimeSeriesFactorModel.Rd 2013-09-11 22:05:46 UTC (rev 3065)
@@ -9,11 +9,11 @@
\item{object}{A fit object created by
fitTimeSeiresFactorModel.}
- \item{newdata}{a vector, matrix, data.frame, xts,
+ \item{newdata}{A vector, matrix, data.frame, xts,
timeSeries or zoo object to be coerced.}
- \item{...}{Any other arguments used in \code{predict.lm}.
- for example newdata and se.fit.}
+ \item{...}{Any other arguments used in \code{predict.lm},
+ such as \code{newdata} and \code{fit.se}.}
}
\description{
Generic function of predict method for
Modified: pkg/FactorAnalytics/man/print.FM.attribution.Rd
===================================================================
--- pkg/FactorAnalytics/man/print.FM.attribution.Rd 2013-09-11 21:31:25 UTC (rev 3064)
+++ pkg/FactorAnalytics/man/print.FM.attribution.Rd 2013-09-11 22:05:46 UTC (rev 3065)
@@ -6,11 +6,11 @@
}
\arguments{
\item{fm.attr}{FM.attribution object created by
- factorModelPerformanceAttribution.}
+ \code{factorModelPerformanceAttribution}.}
}
\description{
Generic function of print method for
- factorModelPerformanceAttribution.
+ \code{factorModelPerformanceAttribution}.
}
\examples{
\dontrun{
Modified: pkg/FactorAnalytics/man/print.FundamentalFactorModel.Rd
===================================================================
--- pkg/FactorAnalytics/man/print.FundamentalFactorModel.Rd 2013-09-11 21:31:25 UTC (rev 3064)
+++ pkg/FactorAnalytics/man/print.FundamentalFactorModel.Rd 2013-09-11 22:05:46 UTC (rev 3065)
@@ -6,17 +6,17 @@
digits = max(3, .Options$digits - 3), ...)
}
\arguments{
- \item{x}{fit object created by
+ \item{x}{Fit object created by
fitFundamentalFactorModel.}
- \item{digits}{integer indicating the number of decimal
+ \item{digits}{Integer indicating the number of decimal
places. Default is 3.}
- \item{...}{Other arguments for print methods.}
+ \item{...}{Other arguments for \code{print} methods.}
}
\description{
Generic function of print method for
- fitFundamentalFactorModel.
+ \code{fitFundamentalFactorModel}.
}
\examples{
data(Stock.df)
Modified: pkg/FactorAnalytics/man/print.StatFactorModel.Rd
===================================================================
--- pkg/FactorAnalytics/man/print.StatFactorModel.Rd 2013-09-11 21:31:25 UTC (rev 3064)
+++ pkg/FactorAnalytics/man/print.StatFactorModel.Rd 2013-09-11 22:05:46 UTC (rev 3065)
@@ -6,16 +6,17 @@
digits = max(3, .Options$digits - 3), ...)
}
\arguments{
- \item{x}{fit object created by
- fitStatisticalFactorModel.}
+ \item{x}{Fit object created by
+ \code{fitStatisticalFactorModel}.}
- \item{digits}{integer indicating the number of decimal
+ \item{digits}{Integer indicating the number of decimal
places. Default is 3.}
- \item{...}{Other arguments for print methods.}
+ \item{...}{Other arguments for \code{print} methods.}
}
\description{
- Generic function of print method for fitStatFactorModel.
+ Generic function of print method for
+ \code{fitStatFactorModel}.
}
\examples{
# load data for fitStatisticalFactorModel.r
Modified: pkg/FactorAnalytics/man/print.TimeSeriesFactorModel.Rd
===================================================================
--- pkg/FactorAnalytics/man/print.TimeSeriesFactorModel.Rd 2013-09-11 21:31:25 UTC (rev 3064)
+++ pkg/FactorAnalytics/man/print.TimeSeriesFactorModel.Rd 2013-09-11 22:05:46 UTC (rev 3065)
@@ -6,16 +6,17 @@
digits = max(3, .Options$digits - 3), ...)
}
\arguments{
- \item{x}{fit object created by fitTimeSeriesFactorModel.}
+ \item{x}{Fit object created by
+ \code{fitTimeSeriesFactorModel}.}
- \item{digits}{integer indicating the number of decimal
+ \item{digits}{Integer indicating the number of decimal
places. Default is 3.}
- \item{...}{arguments to be passed to print method.}
+ \item{...}{Other arguments for \code{print} methods.}
}
\description{
Generic function of print method for
- fitTimeSeriesFactorModel.
+ \code{fitTimeSeriesFactorModel}.
}
\examples{
# load data from the database
Modified: pkg/FactorAnalytics/man/summary.FM.attribution.Rd
===================================================================
--- pkg/FactorAnalytics/man/summary.FM.attribution.Rd 2013-09-11 21:31:25 UTC (rev 3064)
+++ pkg/FactorAnalytics/man/summary.FM.attribution.Rd 2013-09-11 22:05:46 UTC (rev 3065)
@@ -2,15 +2,21 @@
\alias{summary.FM.attribution}
\title{summary FM.attribution object.}
\usage{
- \method{summary}{FM.attribution} (fm.attr)
+ \method{summary}{FM.attribution} (fm.attr,
+ digits = max(3, .Options$digits - 3), ...)
}
\arguments{
\item{fm.attr}{FM.attribution object created by
- factorModelPerformanceAttribution.}
+ \code{factorModelPerformanceAttribution}.}
+
+ \item{digits}{integer indicating the number of decimal
+ places. Default is 3.}
+
+ \item{...}{Other arguments for \code{print} methods.}
}
\description{
Generic function of summary method for
- factorModelPerformanceAttribution.
+ \code{factorModelPerformanceAttribution}.
}
\examples{
# load data from the database
Modified: pkg/FactorAnalytics/man/summary.FundamentalFactorModel.Rd
===================================================================
--- pkg/FactorAnalytics/man/summary.FundamentalFactorModel.Rd 2013-09-11 21:31:25 UTC (rev 3064)
+++ pkg/FactorAnalytics/man/summary.FundamentalFactorModel.Rd 2013-09-11 22:05:46 UTC (rev 3065)
@@ -7,16 +7,16 @@
}
\arguments{
\item{object}{An object created by
- fitFundamentalFactorModel.}
+ \code{fitFundamentalFactorModel}.}
\item{digits}{integer indicating the number of decimal
places. Default is 3.}
- \item{...}{Other arguments for print methods.}
+ \item{...}{Other arguments for \code{print} methods.}
}
\description{
Generic function of summary method for
- fitFundamentalFactorModel.
+ \code{fitFundamentalFactorModel}.
}
\examples{
data(Stock.df)
Modified: pkg/FactorAnalytics/man/summary.StatFactorModel.Rd
===================================================================
--- pkg/FactorAnalytics/man/summary.StatFactorModel.Rd 2013-09-11 21:31:25 UTC (rev 3064)
+++ pkg/FactorAnalytics/man/summary.StatFactorModel.Rd 2013-09-11 22:05:46 UTC (rev 3065)
@@ -2,20 +2,21 @@
\alias{summary.StatFactorModel}
\title{summary method for StatFactorModel object.}
\usage{
- \method{summary}{StatFactorModel} (object, digits = 3)
+ \method{summary}{StatFactorModel} (object, digits = 3,
+ ...)
}
\arguments{
\item{object}{An Object created by
- fitStatisticalFactorModel.}
+ \code{fitStatisticalFactorModel}.}
- \item{digits}{Integer indicating the number of decimal
+ \item{digits}{Integer indicates the number of decimal
places. Default is 3.}
- \item{...}{other option used in \code{summary.lm}}
+ \item{...}{other option used in \code{print} method.}
}
\description{
Generic function of summary method for
- fitStatisticalFactorModel.
+ \code{fitStatisticalFactorModel}.
}
\examples{
# load data from the database
Modified: pkg/FactorAnalytics/man/summary.TimeSeriesFactorModel.Rd
===================================================================
--- pkg/FactorAnalytics/man/summary.TimeSeriesFactorModel.Rd 2013-09-11 21:31:25 UTC (rev 3064)
+++ pkg/FactorAnalytics/man/summary.TimeSeriesFactorModel.Rd 2013-09-11 22:05:46 UTC (rev 3065)
@@ -3,20 +3,20 @@
\title{summary method for TimeSeriesModel object.}
\usage{
\method{summary}{TimeSeriesFactorModel} (object,
- digits = 3)
+ digits = 3, ...)
}
\arguments{
\item{object}{An object created by
- fitTimeSeiresFactorModel.}
+ \code{fitTimeSeiresFactorModel}.}
- \item{digits}{Integer indicating the number of decimal
+ \item{digits}{Integer indicates the number of decimal
places. Default is 3.}
- \item{...}{other option used in \code{summary.lm}}
+ \item{...}{Other option used in \code{print} method.}
}
\description{
Generic function of summary method for
- fitTimeSeriesFactorModel.
+ \code{fitTimeSeriesFactorModel}.
}
\examples{
# load data from the database
More information about the Returnanalytics-commits
mailing list