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

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

Author: rossbennett34
Date: 2014-02-23 21:38:05 +0100 (Sun, 23 Feb 2014)
New Revision: 3335

Removed:
   pkg/PortfolioAnalytics/man/portfolios.combine.Rd
Modified:
   pkg/PortfolioAnalytics/R/generics.R
   pkg/PortfolioAnalytics/README
   pkg/PortfolioAnalytics/man/chart.EfficientFrontierOverlay.Rd
Log:
minor documentation edits

Modified: pkg/PortfolioAnalytics/R/generics.R
===================================================================
--- pkg/PortfolioAnalytics/R/generics.R	2014-02-23 16:47:32 UTC (rev 3334)
+++ pkg/PortfolioAnalytics/R/generics.R	2014-02-23 20:38:05 UTC (rev 3335)
@@ -93,7 +93,7 @@
 #' print method for objects of class \code{summary.optimize.portfolio.rebalancing}
 #' 
 #' @param x an object of class \code{summary.optimize.portfolio.rebalancing}.
-#' @param ... any other passthru parameters
+#' @param \dots any other passthru parameters
 #' @param digits number of digits used for printing
 #' @seealso \code{\link{summary.optimize.portfolio.rebalancing}}
 #' @author Ross Bennett

Modified: pkg/PortfolioAnalytics/README
===================================================================
--- pkg/PortfolioAnalytics/README	2014-02-23 16:47:32 UTC (rev 3334)
+++ pkg/PortfolioAnalytics/README	2014-02-23 20:38:05 UTC (rev 3335)
@@ -5,4 +5,10 @@
 
 All documentation is being done in roxygen as an experiment.  
 We will not be checking in compiled .Rd help file source all the time, mostly just before CRAN releases, so do
-R CMD roxygen -d PortfolioAnalytics from one directory up.
\ No newline at end of file
+R CMD roxygen -d PortfolioAnalytics from one directory up.
+
+Some the Rd files generated by Roxygen add a new line where there should not be one and will result in an R CMD Check warning. These files were manually edited, but will be overwritten the next time roxygen is run.
+
+Running the following command from the /PortfolioAnalytics directory is a temporary fix.
+
+svn revert man/chart.Weights.Rd man/chart.RiskReward.Rd man/plot.Rd man/print.optimize.portfolio.Rd man/chart.EfficientFrontier.Rd man/chart.RiskBudget.Rd man/print.summary.optimize.portfolio.rebalancing.Rd
\ No newline at end of file

Modified: pkg/PortfolioAnalytics/man/chart.EfficientFrontierOverlay.Rd
===================================================================
--- pkg/PortfolioAnalytics/man/chart.EfficientFrontierOverlay.Rd	2014-02-23 16:47:32 UTC (rev 3334)
+++ pkg/PortfolioAnalytics/man/chart.EfficientFrontierOverlay.Rd	2014-02-23 20:38:05 UTC (rev 3335)
@@ -16,7 +16,8 @@
   \item{R}{an xts object of asset returns}
 
   \item{portfolio_list}{list of portfolio objects created
-  by \code{\link{portfolio.spec}}}
+  by \code{\link{portfolio.spec}} and combined with
+  \code{\link{combine.portfolios}}}
 
   \item{type}{type of efficient frontier, see
   \code{\link{create.EfficientFrontier}}}

Deleted: pkg/PortfolioAnalytics/man/portfolios.combine.Rd
===================================================================
--- pkg/PortfolioAnalytics/man/portfolios.combine.Rd	2014-02-23 16:47:32 UTC (rev 3334)
+++ pkg/PortfolioAnalytics/man/portfolios.combine.Rd	2014-02-23 20:38:05 UTC (rev 3335)
@@ -1,20 +0,0 @@
-\name{portfolios.combine}
-\alias{portfolios.combine}
-\title{Combine objects created by portfolio}
-\usage{
-  portfolios.combine(x)
-}
-\arguments{
-  \item{x}{a list of objects created by
-  \code{\link{portfolio.spec}}}
-}
-\value{
-  a \code{portfolio.list} object
-}
-\description{
-  This function takes a list of objects created by
-  \code{\link{portfolio.spec}} and sets the class name
-  attribute to 'portfolio.list' for use in generic
-  functions
-}
-