[Returnanalytics-commits] r2906 - pkg/PortfolioAnalytics/man

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

Author: rossbennett34
Date: 2013-08-27 20:29:05 +0200 (Tue, 27 Aug 2013)
New Revision: 2906

Modified:
   pkg/PortfolioAnalytics/man/print.constraint.Rd
   pkg/PortfolioAnalytics/man/print.optimize.portfolio.DEoptim.Rd
   pkg/PortfolioAnalytics/man/print.optimize.portfolio.GenSA.Rd
   pkg/PortfolioAnalytics/man/print.optimize.portfolio.ROI.Rd
   pkg/PortfolioAnalytics/man/print.optimize.portfolio.pso.Rd
   pkg/PortfolioAnalytics/man/print.optimize.portfolio.random.Rd
   pkg/PortfolioAnalytics/man/print.portfolio.Rd
   pkg/PortfolioAnalytics/man/summary.portfolio.Rd
Log:
Cleaning up generic methods

Modified: pkg/PortfolioAnalytics/man/print.constraint.Rd
===================================================================
--- pkg/PortfolioAnalytics/man/print.constraint.Rd	2013-08-27 18:20:57 UTC (rev 2905)
+++ pkg/PortfolioAnalytics/man/print.constraint.Rd	2013-08-27 18:29:05 UTC (rev 2906)
@@ -2,7 +2,7 @@
 \alias{print.constraint}
 \title{print method for objects of class 'constraint'}
 \usage{
-  print.constraint(obj)
+  print.constraint(x, ...)
 }
 \arguments{
   \item{portfolio}{object of class constraint}

Modified: pkg/PortfolioAnalytics/man/print.optimize.portfolio.DEoptim.Rd
===================================================================
--- pkg/PortfolioAnalytics/man/print.optimize.portfolio.DEoptim.Rd	2013-08-27 18:20:57 UTC (rev 2905)
+++ pkg/PortfolioAnalytics/man/print.optimize.portfolio.DEoptim.Rd	2013-08-27 18:29:05 UTC (rev 2906)
@@ -2,13 +2,13 @@
 \alias{print.optimize.portfolio.DEoptim}
 \title{Printing Output of optimize.portfolio}
 \usage{
-  print.optimize.portfolio.DEoptim(object,
-    digits = max(3, getOption("digits") - 3), ...)
+  print.optimize.portfolio.DEoptim(x, ...,
+    digits = max(3, getOption("digits") - 3))
 }
 \arguments{
-  \item{object}{an object of class
-  "optimize.portfolio.DEoptim" resulting from a call to
-  optimize.portfolio}
+  \item{x}{an object of class
+  \code{optimize.portfolio.DEoptim} resulting from a call
+  to \code{\link{optimize.portfolio}}}
 
   \item{digits}{the number of significant digits to use
   when printing.}

Modified: pkg/PortfolioAnalytics/man/print.optimize.portfolio.GenSA.Rd
===================================================================
--- pkg/PortfolioAnalytics/man/print.optimize.portfolio.GenSA.Rd	2013-08-27 18:20:57 UTC (rev 2905)
+++ pkg/PortfolioAnalytics/man/print.optimize.portfolio.GenSA.Rd	2013-08-27 18:29:05 UTC (rev 2906)
@@ -2,13 +2,13 @@
 \alias{print.optimize.portfolio.GenSA}
 \title{Printing Output of optimize.portfolio}
 \usage{
-  print.optimize.portfolio.GenSA(object,
-    digits = max(3, getOption("digits") - 3), ...)
+  print.optimize.portfolio.GenSA(x, ...,
+    digits = max(3, getOption("digits") - 3))
 }
 \arguments{
-  \item{object}{an object of class
-  "optimize.portfolio.GenSA" resulting from a call to
-  optimize.portfolio}
+  \item{x}{an object of class
+  \code{optimize.portfolio.GenSA} resulting from a call to
+  \code{\link{optimize.portfolio}}}
 
   \item{digits}{the number of significant digits to use
   when printing}

Modified: pkg/PortfolioAnalytics/man/print.optimize.portfolio.ROI.Rd
===================================================================
--- pkg/PortfolioAnalytics/man/print.optimize.portfolio.ROI.Rd	2013-08-27 18:20:57 UTC (rev 2905)
+++ pkg/PortfolioAnalytics/man/print.optimize.portfolio.ROI.Rd	2013-08-27 18:29:05 UTC (rev 2906)
@@ -2,12 +2,13 @@
 \alias{print.optimize.portfolio.ROI}
 \title{Printing Output of optimize.portfolio}
 \usage{
-  print.optimize.portfolio.ROI(object,
-    digits = max(3, getOption("digits") - 3), ...)
+  print.optimize.portfolio.ROI(x, ...,
+    digits = max(3, getOption("digits") - 3))
 }
 \arguments{
-  \item{object}{an object of class "optimize.portfolio.ROI"
-  resulting from a call to optimize.portfolio}
+  \item{x}{an object of class \code{optimize.portfolio.ROI}
+  resulting from a call to
+  \code{\link{optimize.portfolio}}}
 
   \item{digits}{the number of significant digits to use
   when printing.}

Modified: pkg/PortfolioAnalytics/man/print.optimize.portfolio.pso.Rd
===================================================================
--- pkg/PortfolioAnalytics/man/print.optimize.portfolio.pso.Rd	2013-08-27 18:20:57 UTC (rev 2905)
+++ pkg/PortfolioAnalytics/man/print.optimize.portfolio.pso.Rd	2013-08-27 18:29:05 UTC (rev 2906)
@@ -2,12 +2,13 @@
 \alias{print.optimize.portfolio.pso}
 \title{Printing Output of optimize.portfolio}
 \usage{
-  print.optimize.portfolio.pso(object,
-    digits = max(3, getOption("digits") - 3), ...)
+  print.optimize.portfolio.pso(x, ...,
+    digits = max(3, getOption("digits") - 3))
 }
 \arguments{
-  \item{object}{an object of class "optimize.portfolio.pso"
-  resulting from a call to optimize.portfolio}
+  \item{x}{an object of class \code{optimize.portfolio.pso}
+  resulting from a call to
+  \code{\link{optimize.portfolio}}}
 
   \item{digits}{the number of significant digits to use
   when printing.}

Modified: pkg/PortfolioAnalytics/man/print.optimize.portfolio.random.Rd
===================================================================
--- pkg/PortfolioAnalytics/man/print.optimize.portfolio.random.Rd	2013-08-27 18:20:57 UTC (rev 2905)
+++ pkg/PortfolioAnalytics/man/print.optimize.portfolio.random.Rd	2013-08-27 18:29:05 UTC (rev 2906)
@@ -2,13 +2,13 @@
 \alias{print.optimize.portfolio.random}
 \title{Printing Output of optimize.portfolio}
 \usage{
-  print.optimize.portfolio.random(object,
-    digits = max(3, getOption("digits") - 3), ...)
+  print.optimize.portfolio.random(x, ...,
+    digits = max(3, getOption("digits") - 3))
 }
 \arguments{
-  \item{object}{an object of class
-  "optimize.portfolio.random" resulting from a call to
-  optimize.portfolio}
+  \item{x}{an object of class
+  \code{optimize.portfolio.random} resulting from a call to
+  \code{\link{optimize.portfolio}}}
 
   \item{digits}{the number of significant digits to use
   when printing.}

Modified: pkg/PortfolioAnalytics/man/print.portfolio.Rd
===================================================================
--- pkg/PortfolioAnalytics/man/print.portfolio.Rd	2013-08-27 18:20:57 UTC (rev 2905)
+++ pkg/PortfolioAnalytics/man/print.portfolio.Rd	2013-08-27 18:29:05 UTC (rev 2906)
@@ -2,13 +2,14 @@
 \alias{print.portfolio}
 \title{Printing Portfolio Specification Objects}
 \usage{
-  print.portfolio(portfolio)
+  print.portfolio(x, ...)
 }
 \arguments{
-  \item{portfolio}{object of class portfolio}
+  \item{x}{object of class \code{portfolio}}
 }
 \description{
-  Print method for class "portfolio"
+  Print method for objects of class \code{portfolio}
+  created with \code{\link{portfolio.spec}}
 }
 \author{
   Ross Bennett

Modified: pkg/PortfolioAnalytics/man/summary.portfolio.Rd
===================================================================
--- pkg/PortfolioAnalytics/man/summary.portfolio.Rd	2013-08-27 18:20:57 UTC (rev 2905)
+++ pkg/PortfolioAnalytics/man/summary.portfolio.Rd	2013-08-27 18:29:05 UTC (rev 2906)
@@ -1,14 +1,15 @@
 \name{summary.portfolio}
 \alias{summary.portfolio}
-\title{Summarizing Portfolio Specification Objects}
+\title{Summarize Portfolio Specification Objects}
 \usage{
-  summary.portfolio(portfolio)
+  summary.portfolio(object, ...)
 }
 \arguments{
-  \item{portfolio}{object of class portfolio}
+  \item{object}{object of class portfolio}
 }
 \description{
-  summary method for class "portfolio"
+  summary method for class \code{portfolio} created with
+  \code{\link{portfolio.spec}}
 }
 \author{
   Ross Bennett