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

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

Author: rossbennett34
Date: 2013-06-23 20:16:47 +0200 (Sun, 23 Jun 2013)
New Revision: 2407

Modified:
   pkg/PortfolioAnalytics/man/get.constraints.Rd
Log:
updated documentation for get.constraints after running roxygenize

Modified: pkg/PortfolioAnalytics/man/get.constraints.Rd
===================================================================
--- pkg/PortfolioAnalytics/man/get.constraints.Rd	2013-06-23 18:15:06 UTC (rev 2406)
+++ pkg/PortfolioAnalytics/man/get.constraints.Rd	2013-06-23 18:16:47 UTC (rev 2407)
@@ -1,8 +1,6 @@
 \name{get.constraints}
 \alias{get.constraints}
-\title{Helper function to get the enabled constraints out of the portfolio object, see \code{\link{portfolio.spec}}
- Returns an object of class constraint which is a flat list of weight_sum, box, and group constraints.
- Uses the same naming as the v1_constraint object which may be useful when passed to other functions.}
+\title{Helper function to get the enabled constraints out of the portfolio object, see \code{\link{portfolio.spec}}}
 \usage{
   get.constraints(portfolio)
 }
@@ -10,8 +8,17 @@
   \item{portfolio}{an object of class 'portfolio'}
 }
 \description{
-  Helper function to get the enabled constraints out of the
-  portfolio object, see \code{\link{portfolio.spec}}
+  When the v1_constraint object is instantiated via
+  constraint, the arguments min_sum, max_sum, min, and max
+  are either specified by the user or default values are
+  assigned. These are required by other functions such as
+  optimize.portfolio. This function will check that these
+  variables are in the portfolio object in the constraints
+  list. This function could be used at the beginning of
+  optimize.portfolio to check the constraints in the
+  portfolio object.
+}
+\details{
   Returns an object of class constraint which is a flat
   list of weight_sum, box, and group constraints.  Uses the
   same naming as the v1_constraint object which may be