[Returnanalytics-commits] r3231 - in pkg/PortfolioAnalytics: R man
noreply at r-forge.r-project.org
noreply at r-forge.r-project.org
Fri Oct 18 03:36:36 CEST 2013
Author: rossbennett34
Date: 2013-10-18 03:36:36 +0200 (Fri, 18 Oct 2013)
New Revision: 3231
Modified:
pkg/PortfolioAnalytics/R/generics.R
pkg/PortfolioAnalytics/man/print.constraint.Rd
pkg/PortfolioAnalytics/man/print.efficient.frontier.Rd
pkg/PortfolioAnalytics/man/print.optimize.portfolio.Rd
pkg/PortfolioAnalytics/man/print.portfolio.Rd
pkg/PortfolioAnalytics/man/print.summary.optimize.portfolio.Rd
pkg/PortfolioAnalytics/man/summary.optimize.portfolio.Rd
pkg/PortfolioAnalytics/man/summary.portfolio.Rd
Log:
Cleaning up documentation for generics.
Modified: pkg/PortfolioAnalytics/R/generics.R
===================================================================
--- pkg/PortfolioAnalytics/R/generics.R 2013-10-18 01:21:05 UTC (rev 3230)
+++ pkg/PortfolioAnalytics/R/generics.R 2013-10-18 01:36:36 UTC (rev 3231)
@@ -47,6 +47,7 @@
#'
#' @param x an object of class \code{portfolio}
#' @param \dots any other passthru parameters
+#' @seealso \code{\link{portfolio.spec}}
#' @author Ross Bennett
#' @method print portfolio
#' @S3method print portfolio
@@ -189,8 +190,9 @@
#'
#' summary method for class \code{portfolio} created with \code{\link{portfolio.spec}}
#'
-#' @param object object of class portfolio
+#' @param object an object of class \code{portfolio}
#' @param \dots any other passthru parameters
+#' @seealso \code{\link{portfolio.spec}}
#' @author Ross Bennett
#' @method summary portfolio
#' @export
@@ -238,9 +240,9 @@
}
}
-#' print method for objects of class 'constraint'
+#' print method for constraint objects
#'
-#' @param x object of class constraint
+#' @param x object of class \code{constraint}
#' @param \dots any other passthru parameters
#' @author Ross Bennett
#' @method print constraint
@@ -251,11 +253,12 @@
#' Printing output of optimize.portfolio
#'
-#' print method for optimize.portfolio objects
+#' print method for \code{optimize.portfolio} objects
#'
#' @param x an object used to select a method
#' @param \dots any other passthru parameters
#' @param digits the number of significant digits to use when printing.
+#' @seealso \code{\link{optimize.portfolio}}
#' @author Ross Bennett
#' @rdname print.optimize.portfolio
#' @method print optimize.portfolio.ROI
@@ -461,12 +464,13 @@
cat("\n")
}
-#' Summarizing Output of optimize.portfolio
+#' Printing summary output of optimize.portfolio
#'
-#' summary method for class "optimize.portfolio"
+#' print method for objects of class \code{summary.optimize.portfolio}
#'
-#' @param object an object of class "optimize.portfolio.pso" resulting from a call to optimize.portfolio
+#' @param x an object of class \code{summary.optimize.portfolio}.
#' @param ... any other passthru parameters. Currently not used.
+#' @seealso \code{\link{summary.optimize.portfolio}}
#' @author Ross Bennett
#' @method print summary.optimize.portfolio
#' @S3method print summary.optimize.portfolio
@@ -664,10 +668,11 @@
#' Summarizing output of optimize.portfolio
#'
-#' summary method for class "optimize.portfolio"
+#' summary method for class \code{optimize.portfolio}
#'
-#' @param object an object of class "optimize.portfolio.pso" resulting from a call to optimize.portfolio
+#' @param object an object of class \code{optimize.portfolio}.
#' @param ... any other passthru parameters. Currently not used.
+#' @seealso \code{\link{optimize.portfolio}}
#' @author Ross Bennett
#' @method summary optimize.portfolio
#' @S3method summary optimize.portfolio
@@ -798,6 +803,7 @@
#'
#' @param x objective of class \code{efficient.frontier}
#' @param \dots any other passthru parameters
+#' @seealso \code{\link{create.EfficientFrontier}}
#' @author Ross Bennett
#' @method print efficient.frontier
#' @S3method print efficient.frontier
Modified: pkg/PortfolioAnalytics/man/print.constraint.Rd
===================================================================
--- pkg/PortfolioAnalytics/man/print.constraint.Rd 2013-10-18 01:21:05 UTC (rev 3230)
+++ pkg/PortfolioAnalytics/man/print.constraint.Rd 2013-10-18 01:36:36 UTC (rev 3231)
@@ -1,16 +1,16 @@
\name{print.constraint}
\alias{print.constraint}
-\title{print method for objects of class 'constraint'}
+\title{print method for constraint objects}
\usage{
\method{print}{constraint} (x, ...)
}
\arguments{
- \item{x}{object of class constraint}
+ \item{x}{object of class \code{constraint}}
\item{\dots}{any other passthru parameters}
}
\description{
- print method for objects of class 'constraint'
+ print method for constraint objects
}
\author{
Ross Bennett
Modified: pkg/PortfolioAnalytics/man/print.efficient.frontier.Rd
===================================================================
--- pkg/PortfolioAnalytics/man/print.efficient.frontier.Rd 2013-10-18 01:21:05 UTC (rev 3230)
+++ pkg/PortfolioAnalytics/man/print.efficient.frontier.Rd 2013-10-18 01:36:36 UTC (rev 3231)
@@ -18,4 +18,7 @@
\author{
Ross Bennett
}
+\seealso{
+ \code{\link{create.EfficientFrontier}}
+}
Modified: pkg/PortfolioAnalytics/man/print.optimize.portfolio.Rd
===================================================================
--- pkg/PortfolioAnalytics/man/print.optimize.portfolio.Rd 2013-10-18 01:21:05 UTC (rev 3230)
+++ pkg/PortfolioAnalytics/man/print.optimize.portfolio.Rd 2013-10-18 01:36:36 UTC (rev 3231)
@@ -30,9 +30,12 @@
when printing.}
}
\description{
- print method for optimize.portfolio objects
+ print method for \code{optimize.portfolio} objects
}
\author{
Ross Bennett
}
+\seealso{
+ \code{\link{optimize.portfolio}}
+}
Modified: pkg/PortfolioAnalytics/man/print.portfolio.Rd
===================================================================
--- pkg/PortfolioAnalytics/man/print.portfolio.Rd 2013-10-18 01:21:05 UTC (rev 3230)
+++ pkg/PortfolioAnalytics/man/print.portfolio.Rd 2013-10-18 01:36:36 UTC (rev 3231)
@@ -16,4 +16,7 @@
\author{
Ross Bennett
}
+\seealso{
+ \code{\link{portfolio.spec}}
+}
Modified: pkg/PortfolioAnalytics/man/print.summary.optimize.portfolio.Rd
===================================================================
--- pkg/PortfolioAnalytics/man/print.summary.optimize.portfolio.Rd 2013-10-18 01:21:05 UTC (rev 3230)
+++ pkg/PortfolioAnalytics/man/print.summary.optimize.portfolio.Rd 2013-10-18 01:36:36 UTC (rev 3231)
@@ -1,20 +1,24 @@
\name{print.summary.optimize.portfolio}
\alias{print.summary.optimize.portfolio}
-\title{Summarizing Output of optimize.portfolio}
+\title{Printing summary output of optimize.portfolio}
\usage{
\method{print}{summary.optimize.portfolio} (x, ...)
}
\arguments{
- \item{object}{an object of class "optimize.portfolio.pso"
- resulting from a call to optimize.portfolio}
+ \item{x}{an object of class
+ \code{summary.optimize.portfolio}.}
\item{...}{any other passthru parameters. Currently not
used.}
}
\description{
- summary method for class "optimize.portfolio"
+ print method for objects of class
+ \code{summary.optimize.portfolio}
}
\author{
Ross Bennett
}
+\seealso{
+ \code{\link{summary.optimize.portfolio}}
+}
Modified: pkg/PortfolioAnalytics/man/summary.optimize.portfolio.Rd
===================================================================
--- pkg/PortfolioAnalytics/man/summary.optimize.portfolio.Rd 2013-10-18 01:21:05 UTC (rev 3230)
+++ pkg/PortfolioAnalytics/man/summary.optimize.portfolio.Rd 2013-10-18 01:36:36 UTC (rev 3231)
@@ -5,16 +5,19 @@
\method{summary}{optimize.portfolio} (object, ...)
}
\arguments{
- \item{object}{an object of class "optimize.portfolio.pso"
- resulting from a call to optimize.portfolio}
+ \item{object}{an object of class
+ \code{optimize.portfolio}.}
\item{...}{any other passthru parameters. Currently not
used.}
}
\description{
- summary method for class "optimize.portfolio"
+ summary method for class \code{optimize.portfolio}
}
\author{
Ross Bennett
}
+\seealso{
+ \code{\link{optimize.portfolio}}
+}
Modified: pkg/PortfolioAnalytics/man/summary.portfolio.Rd
===================================================================
--- pkg/PortfolioAnalytics/man/summary.portfolio.Rd 2013-10-18 01:21:05 UTC (rev 3230)
+++ pkg/PortfolioAnalytics/man/summary.portfolio.Rd 2013-10-18 01:36:36 UTC (rev 3231)
@@ -5,7 +5,7 @@
\method{summary}{portfolio} (object, ...)
}
\arguments{
- \item{object}{object of class portfolio}
+ \item{object}{an object of class \code{portfolio}}
\item{\dots}{any other passthru parameters}
}
@@ -16,4 +16,7 @@
\author{
Ross Bennett
}
+\seealso{
+ \code{\link{portfolio.spec}}
+}
More information about the Returnanalytics-commits
mailing list