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

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

Author: rossbennett34
Date: 2013-09-22 23:55:40 +0200 (Sun, 22 Sep 2013)
New Revision: 3160

Added:
   pkg/PortfolioAnalytics/man/combine.optimizations.Rd
Modified:
   pkg/PortfolioAnalytics/R/utility.combine.R
Log:
Changing optimizations.combine to combine.optimizations.

Modified: pkg/PortfolioAnalytics/R/utility.combine.R
===================================================================
--- pkg/PortfolioAnalytics/R/utility.combine.R	2013-09-22 21:48:22 UTC (rev 3159)
+++ pkg/PortfolioAnalytics/R/utility.combine.R	2013-09-22 21:55:40 UTC (rev 3160)
@@ -8,7 +8,7 @@
 #' @param x a list of objects created by \code{\link{optimize.portfolio}}
 #' @return an \code{opt.list} object
 #' @export
-optimizations.combine <- function(x){
+combine.optimizations <- function(x){
   if(!is.list(x)) stop("x must be passed in as a list")
   for(i in 1:length(x)){
     if(!inherits(x[[i]], "optimize.portfolio")) stop("All objects in x must be of class 'optimize.portfolio'")

Added: pkg/PortfolioAnalytics/man/combine.optimizations.Rd
===================================================================
--- pkg/PortfolioAnalytics/man/combine.optimizations.Rd	                        (rev 0)
+++ pkg/PortfolioAnalytics/man/combine.optimizations.Rd	2013-09-22 21:55:40 UTC (rev 3160)
@@ -0,0 +1,19 @@
+\name{combine.optimizations}
+\alias{combine.optimizations}
+\title{Combine objects created by optimize.portfolio}
+\usage{
+  combine.optimizations(x)
+}
+\arguments{
+  \item{x}{a list of objects created by
+  \code{\link{optimize.portfolio}}}
+}
+\value{
+  an \code{opt.list} object
+}
+\description{
+  This function takes a list of objects created by
+  \code{\link{optimize.portfolio}} and sets the class name
+  attribute to 'opt.list' for use in generic functions
+}
+