[Returnanalytics-commits] r2436 - in pkg/FactorAnalytics: R man

[noreply at r-forge.r-project.org]

Author: chenyian
Date: 2013-06-26 01:22:51 +0200 (Wed, 26 Jun 2013)
New Revision: 2436

Modified:
   pkg/FactorAnalytics/R/predict.StatFactorModel.r
   pkg/FactorAnalytics/R/summary.TimeSeriesFactorModel.r
   pkg/FactorAnalytics/man/predict.StatFactorModel.Rd
   pkg/FactorAnalytics/man/summary.TimeSeriesFactorModel.Rd
Log:
add summary.StatFactorModel.r and summary.StatFactorModel.Rd

Modified: pkg/FactorAnalytics/R/predict.StatFactorModel.r
===================================================================
--- pkg/FactorAnalytics/R/predict.StatFactorModel.r	2013-06-25 21:57:59 UTC (rev 2435)
+++ pkg/FactorAnalytics/R/predict.StatFactorModel.r	2013-06-25 23:22:51 UTC (rev 2436)
@@ -3,7 +3,7 @@
 #' Generic function of predict method for fitStatisticalFactorModel. It utilizes
 #' function \code{predict.lm}.
 #' 
-#' @param fit "StatFactorModel" object created by fitTimeSeiresFactorModel.
+#' @param fit "StatFactorModel" object created by fitStatisticalFactorModel.
 #' @param newdata An optional data frame in which to look for variables with which to predict. 
 #' If omitted, the fitted values are used.
 #' @param ... Any other arguments used in \code{predict.lm}

Modified: pkg/FactorAnalytics/R/summary.TimeSeriesFactorModel.r
===================================================================
--- pkg/FactorAnalytics/R/summary.TimeSeriesFactorModel.r	2013-06-25 21:57:59 UTC (rev 2435)
+++ pkg/FactorAnalytics/R/summary.TimeSeriesFactorModel.r	2013-06-25 23:22:51 UTC (rev 2436)
@@ -1,9 +1,11 @@
 #' summary method for TimeSeriesModel object.
 #' 
-#' Generic function of summary method for fitTimeSeriesFactorModel.
+#' Generic function of summary method for fitTimeSeriesFactorModel. 
+#' It utilizes \code{summary.lm}
 #' 
 #' 
 #' @param fit fit object created by fitTimeSeiresFactorModel.
+#' @param ... other option used in \code{summary.lm}
 #' @author Yi-An Chen.
 #' @examples
 #' 
@@ -19,8 +21,7 @@
 #' 
 #' @export
 #' 
-summary.TimeSeriesFactorModel <- 
-  function(fit){
-     lapply(fit[[1]], summary)
+summary.TimeSeriesFactorModel <- function(fit,...){
+     lapply(fit[[1]], summary,...)
   }
     

Modified: pkg/FactorAnalytics/man/predict.StatFactorModel.Rd
===================================================================
--- pkg/FactorAnalytics/man/predict.StatFactorModel.Rd	2013-06-25 21:57:59 UTC (rev 2435)
+++ pkg/FactorAnalytics/man/predict.StatFactorModel.Rd	2013-06-25 23:22:51 UTC (rev 2436)
@@ -6,7 +6,7 @@
 }
 \arguments{
   \item{fit}{"StatFactorModel" object created by
-  fitTimeSeiresFactorModel.}
+  fitStatisticalFactorModel.}
 
   \item{newdata}{An optional data frame in which to look
   for variables with which to predict. If omitted, the

Modified: pkg/FactorAnalytics/man/summary.TimeSeriesFactorModel.Rd
===================================================================
--- pkg/FactorAnalytics/man/summary.TimeSeriesFactorModel.Rd	2013-06-25 21:57:59 UTC (rev 2435)
+++ pkg/FactorAnalytics/man/summary.TimeSeriesFactorModel.Rd	2013-06-25 23:22:51 UTC (rev 2436)
@@ -2,15 +2,17 @@
 \alias{summary.TimeSeriesFactorModel}
 \title{summary method for TimeSeriesModel object.}
 \usage{
-  summary.TimeSeriesFactorModel(fit)
+  summary.TimeSeriesFactorModel(fit, ...)
 }
 \arguments{
   \item{fit}{fit object created by
   fitTimeSeiresFactorModel.}
+
+  \item{...}{other option used in \code{summary.lm}}
 }
 \description{
   Generic function of summary method for
-  fitTimeSeriesFactorModel.
+  fitTimeSeriesFactorModel. It utilizes \code{summary.lm}
 }
 \examples{
 # load data from the database