[Returnanalytics-commits] r2765 - in pkg/PortfolioAnalytics: R man

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

Author: rossbennett34
Date: 2013-08-11 05:07:41 +0200 (Sun, 11 Aug 2013)
New Revision: 2765

Modified:
   pkg/PortfolioAnalytics/R/charts.RP.R
   pkg/PortfolioAnalytics/man/charts.RP.Rd
   pkg/PortfolioAnalytics/man/plot.optimize.portfolio.random.Rd
Log:
updating documentation for charts.RP

Modified: pkg/PortfolioAnalytics/R/charts.RP.R
===================================================================
--- pkg/PortfolioAnalytics/R/charts.RP.R	2013-08-11 03:05:33 UTC (rev 2764)
+++ pkg/PortfolioAnalytics/R/charts.RP.R	2013-08-11 03:07:41 UTC (rev 2765)
@@ -246,7 +246,9 @@
 #' \code{risk.col},\code{return.col}, and weights columns all properly named.  
 #' 
 #' @param RP set of random portfolios created by \code{\link{optimize.portfolio}}
-#' @param R an optional xts, vector, matrix, data frame, timeSeries or zoo 
+#' @param R an optional an xts, vector, matrix, data frame, timeSeries or zoo 
+#' object of asset returns, used to recalulate the objective function when
+#' return.col or risk.col is not part of the extractStats output.
 #' @param ... any other passthru parameters 
 #' @param risk.col string name of column to use for risk (horizontal axis)
 #' @param return.col string name of column to use for returns (vertical axis)
@@ -286,6 +288,8 @@
 #' @param x set of portfolios created by \code{\link{optimize.portfolio}}
 #' @param ... any other passthru parameters 
 #' @param R an optional an xts, vector, matrix, data frame, timeSeries or zoo 
+#' object of asset returns, used to recalulate the objective function when
+#' return.col or risk.col is not part of the extractStats output.
 #' @param risk.col string name of column to use for risk (horizontal axis)
 #' @param return.col string name of column to use for returns (vertical axis)
 #' @param neighbors set of 'neighbor portfolios to overplot

Modified: pkg/PortfolioAnalytics/man/charts.RP.Rd
===================================================================
--- pkg/PortfolioAnalytics/man/charts.RP.Rd	2013-08-11 03:05:33 UTC (rev 2764)
+++ pkg/PortfolioAnalytics/man/charts.RP.Rd	2013-08-11 03:07:41 UTC (rev 2765)
@@ -9,8 +9,10 @@
   \item{RP}{set of random portfolios created by
   \code{\link{optimize.portfolio}}}
 
-  \item{R}{an optional xts, vector, matrix, data frame,
-  timeSeries or zoo}
+  \item{R}{an optional an xts, vector, matrix, data frame,
+  timeSeries or zoo object of asset returns, used to
+  recalulate the objective function when return.col or
+  risk.col is not part of the extractStats output.}
 
   \item{...}{any other passthru parameters}
 

Modified: pkg/PortfolioAnalytics/man/plot.optimize.portfolio.random.Rd
===================================================================
--- pkg/PortfolioAnalytics/man/plot.optimize.portfolio.random.Rd	2013-08-11 03:05:33 UTC (rev 2764)
+++ pkg/PortfolioAnalytics/man/plot.optimize.portfolio.random.Rd	2013-08-11 03:07:41 UTC (rev 2765)
@@ -13,7 +13,9 @@
   \item{...}{any other passthru parameters}
 
   \item{R}{an optional an xts, vector, matrix, data frame,
-  timeSeries or zoo}
+  timeSeries or zoo object of asset returns, used to
+  recalulate the objective function when return.col or
+  risk.col is not part of the extractStats output.}
 
   \item{risk.col}{string name of column to use for risk
   (horizontal axis)}