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

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

Author: rossbennett34
Date: 2013-08-24 22:16:35 +0200 (Sat, 24 Aug 2013)
New Revision: 2877

Added:
   pkg/PortfolioAnalytics/man/chart.Weights.EF.Rd
Modified:
   pkg/PortfolioAnalytics/R/charts.efficient.frontier.R
Log:
Cleaning up documentation for chart.Weights.EF

Modified: pkg/PortfolioAnalytics/R/charts.efficient.frontier.R
===================================================================
--- pkg/PortfolioAnalytics/R/charts.efficient.frontier.R	2013-08-24 20:12:25 UTC (rev 2876)
+++ pkg/PortfolioAnalytics/R/charts.efficient.frontier.R	2013-08-24 20:16:35 UTC (rev 2877)
@@ -181,7 +181,7 @@
 #' 
 #' This creates a stacked column chart of the weights of portfolios along the efficient frontier.
 #' 
-#' @param object object of class 'efficient.frontier' created by \code{\link{create.EfficientFrontier}}.
+#' @param object object of class \code{efficient.frontier} or \code{optimize.portfolio}.
 #' @param colorset color palette to use.
 #' @param ... passthrough parameters to \code{barplot}.
 #' @param n.portfolios number of portfolios to extract along the efficient frontier.
@@ -189,7 +189,7 @@
 #' @param match.col match.col string name of column to use for risk (horizontal axis).
 #' Must match the name of an objective.
 #' @param main main title used in the plot.
-#' @param cex.lab The magnification to be used for x- and y-axis labels relative to the current setting of 'cex'.
+#' @param cex.lab The magnification to be used for x-axis and y-axis labels relative to the current setting of 'cex'.
 #' @param cex.axis The magnification to be used for sizing the axis text relative to the current setting of 'cex', similar to \code{\link{plot}}.
 #' @param cex.legend The magnification to be used for sizing the legend relative to the current setting of 'cex', similar to \code{\link{plot}}.
 #' @param legend.labels character vector to use for the legend labels

Added: pkg/PortfolioAnalytics/man/chart.Weights.EF.Rd
===================================================================
--- pkg/PortfolioAnalytics/man/chart.Weights.EF.Rd	                        (rev 0)
+++ pkg/PortfolioAnalytics/man/chart.Weights.EF.Rd	2013-08-24 20:16:35 UTC (rev 2877)
@@ -0,0 +1,69 @@
+\name{chart.Weights.EF}
+\alias{chart.Weights.EF}
+\alias{chart.Weights.EF.efficient.frontier}
+\alias{chart.Weights.EF.optimize.portfolio}
+\title{chart the weights along the efficient frontier}
+\usage{
+  chart.Weights.EF(object, colorset = NULL, ...,
+    n.portfolios = 25, match.col = "ES",
+    main = "EF Weights", cex.lab = 0.8, cex.axis = 0.8,
+    cex.legend = 0.8, legend.labels = NULL,
+    element.color = "darkgray")
+
+  chart.Weights.EF.efficient.frontier(object,
+    colorset = NULL, ..., n.portfolios = 25,
+    match.col = "ES", main = "EF Weights", cex.lab = 0.8,
+    cex.axis = 0.8, cex.legend = 0.8, legend.labels = NULL,
+    element.color = "darkgray")
+
+  chart.Weights.EF.optimize.portfolio(object,
+    colorset = NULL, ..., n.portfolios = 25,
+    match.col = "ES", main = "EF Weights", cex.lab = 0.8,
+    cex.axis = 0.8, cex.legend = 0.8, legend.labels = NULL,
+    element.color = "darkgray")
+}
+\arguments{
+  \item{object}{object of class \code{efficient.frontier}
+  or \code{optimize.portfolio}.}
+
+  \item{colorset}{color palette to use.}
+
+  \item{...}{passthrough parameters to \code{barplot}.}
+
+  \item{n.portfolios}{number of portfolios to extract along
+  the efficient frontier. This is only used for objects of
+  class \code{optimize.portfolio}}
+
+  \item{match.col}{match.col string name of column to use
+  for risk (horizontal axis). Must match the name of an
+  objective.}
+
+  \item{main}{main title used in the plot.}
+
+  \item{cex.lab}{The magnification to be used for x-axis
+  and y-axis labels relative to the current setting of
+  'cex'.}
+
+  \item{cex.axis}{The magnification to be used for sizing
+  the axis text relative to the current setting of 'cex',
+  similar to \code{\link{plot}}.}
+
+  \item{cex.legend}{The magnification to be used for sizing
+  the legend relative to the current setting of 'cex',
+  similar to \code{\link{plot}}.}
+
+  \item{legend.labels}{character vector to use for the
+  legend labels}
+
+  \item{element.color}{provides the color for drawing
+  less-important chart elements, such as the box lines,
+  axis lines, etc.}
+}
+\description{
+  This creates a stacked column chart of the weights of
+  portfolios along the efficient frontier.
+}
+\author{
+  Ross Bennett
+}
+