[Blotter-commits] r1478 - in pkg/quantstrat: R man

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

Author: opentrades
Date: 2013-06-03 13:44:34 +0200 (Mon, 03 Jun 2013)
New Revision: 1478

Added:
   pkg/quantstrat/man/load.strategy.Rd
   pkg/quantstrat/man/save.strategy.Rd
Modified:
   pkg/quantstrat/R/strategy.R
Log:
- added some documentation for load.strategy() and save.strategy()



Modified: pkg/quantstrat/R/strategy.R
===================================================================
--- pkg/quantstrat/R/strategy.R	2013-05-27 17:00:35 UTC (rev 1477)
+++ pkg/quantstrat/R/strategy.R	2013-06-03 11:44:34 UTC (rev 1478)
@@ -202,7 +202,8 @@
     assign(strategy$name, strategy, envir=as.environment(envir))
 }
 
-# load a strategy object from disk into memory
+#' load a strategy object from disk into memory
+#' @param strategy.name a string specifying the name of the strategy object; will also be used to create a file name
 #' @export
 load.strategy <- function(strategy.name)
 {
@@ -212,7 +213,8 @@
     assign(.strategy$strategy$name, .strategy$strategy, envir=.strategy)
 }
 
-# save a strategy object from memory onto disk
+#' save a strategy object from memory onto disk
+#' @param strategy.name a string specifying the name of the strategy object; will also be used to create a file name
 #' @export
 save.strategy <- function(strategy.name)
 {

Added: pkg/quantstrat/man/load.strategy.Rd
===================================================================
--- pkg/quantstrat/man/load.strategy.Rd	                        (rev 0)
+++ pkg/quantstrat/man/load.strategy.Rd	2013-06-03 11:44:34 UTC (rev 1478)
@@ -0,0 +1,14 @@
+\name{load.strategy}
+\alias{load.strategy}
+\title{load a strategy object from disk into memory}
+\usage{
+  load.strategy(strategy.name)
+}
+\arguments{
+  \item{strategy.name}{a string specifying the name of the
+  strategy object; will also be used to create a file name}
+}
+\description{
+  load a strategy object from disk into memory
+}
+

Added: pkg/quantstrat/man/save.strategy.Rd
===================================================================
--- pkg/quantstrat/man/save.strategy.Rd	                        (rev 0)
+++ pkg/quantstrat/man/save.strategy.Rd	2013-06-03 11:44:34 UTC (rev 1478)
@@ -0,0 +1,14 @@
+\name{save.strategy}
+\alias{save.strategy}
+\title{save a strategy object from memory onto disk}
+\usage{
+  save.strategy(strategy.name)
+}
+\arguments{
+  \item{strategy.name}{a string specifying the name of the
+  strategy object; will also be used to create a file name}
+}
+\description{
+  save a strategy object from memory onto disk
+}
+