[Blotter-commits] r614 - pkg/quantstrat/man

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

Author: gsee
Date: 2011-06-06 22:58:40 +0200 (Mon, 06 Jun 2011)
New Revision: 614

Modified:
   pkg/quantstrat/man/add.paramLookupTable.Rd
   pkg/quantstrat/man/add.parameter.Rd
   pkg/quantstrat/man/addPosLimit.Rd
   pkg/quantstrat/man/getParams.Rd
   pkg/quantstrat/man/paramLookup.Rd
Log:
-updated docs

Modified: pkg/quantstrat/man/add.paramLookupTable.Rd
===================================================================
--- pkg/quantstrat/man/add.paramLookupTable.Rd	2011-06-06 20:36:59 UTC (rev 613)
+++ pkg/quantstrat/man/add.paramLookupTable.Rd	2011-06-06 20:58:40 UTC (rev 614)
@@ -3,7 +3,7 @@
 \title{add parameters to strategy objects: ALPHA CODE USE WITH CARE...}
 \usage{add.paramLookupTable(strategy, type, name, paramTable)}
 \description{add parameters to strategy objects: ALPHA CODE USE WITH CARE}
-\arguments{\item{strategy}{}
-\item{type}{}
-\item{name}{}
-\item{paramTable}{}}
+\arguments{\item{strategy}{strategy}
+\item{type}{type}
+\item{name}{name}
+\item{paramTable}{paramTable}}

Modified: pkg/quantstrat/man/add.parameter.Rd
===================================================================
--- pkg/quantstrat/man/add.parameter.Rd	2011-06-06 20:36:59 UTC (rev 613)
+++ pkg/quantstrat/man/add.parameter.Rd	2011-06-06 20:58:40 UTC (rev 614)
@@ -4,11 +4,11 @@
 \usage{add.parameter(strategy, type=c("indicator", "signal"), add.to.name, method=c("lookup", "lookup.range", "calc"), arguments, label, ...,
     store=FALSE)}
 \description{add parameters to strategy objects: ALPHA CODE USE WITH CARE}
-\arguments{\item{strategy}{}
-\item{type}{}
-\item{add.to.name}{}
-\item{method}{}
-\item{arguments}{}
-\item{label}{}
-\item{...}{}
-\item{store}{}}
+\arguments{\item{strategy}{strategy}
+\item{type}{type}
+\item{add.to.name}{add.to.name}
+\item{method}{method}
+\item{arguments}{arguments}
+\item{label}{label}
+\item{...}{dots}
+\item{store}{store?}}

Modified: pkg/quantstrat/man/addPosLimit.Rd
===================================================================
--- pkg/quantstrat/man/addPosLimit.Rd	2011-06-06 20:36:59 UTC (rev 613)
+++ pkg/quantstrat/man/addPosLimit.Rd	2011-06-06 20:58:40 UTC (rev 614)
@@ -1,7 +1,8 @@
 \name{addPosLimit}
 \alias{addPosLimit}
 \title{add position and level limits at timestamp...}
-\usage{addPosLimit(portfolio, symbol, timestamp, maxpos, longlevels=1, minpos=0, shortlevels=0)}
+\usage{addPosLimit(portfolio, symbol, timestamp, maxpos, longlevels = 1,
+                 minpos = -maxpos, shortlevels = longlevels)}
 \description{add position and level limits at timestamp}
 \details{levels are a simplification of more complex (proprietary) 
 techniques sometimes used for order sizing.  

Modified: pkg/quantstrat/man/getParams.Rd
===================================================================
--- pkg/quantstrat/man/getParams.Rd	2011-06-06 20:36:59 UTC (rev 613)
+++ pkg/quantstrat/man/getParams.Rd	2011-06-06 20:58:40 UTC (rev 614)
@@ -3,7 +3,7 @@
 \title{get parameterized arguments list out of the strategy environment...}
 \usage{getParams(strategy, symbol, type, name)}
 \description{get parameterized arguments list out of the strategy environment}
-\arguments{\item{strategy}{}
-\item{symbol}{}
-\item{type}{}
-\item{name}{}}
+\arguments{\item{strategy}{strategy}
+\item{symbol}{symbol}
+\item{type}{type}
+\item{name}{name}}

Modified: pkg/quantstrat/man/paramLookup.Rd
===================================================================
--- pkg/quantstrat/man/paramLookup.Rd	2011-06-06 20:36:59 UTC (rev 613)
+++ pkg/quantstrat/man/paramLookup.Rd	2011-06-06 20:58:40 UTC (rev 614)
@@ -3,9 +3,9 @@
 \title{add parameters to strategy objects: ALPHA CODE USE WITH CARE...}
 \usage{paramLookup(strategy, symbol, type, name, parameter, ...)}
 \description{add parameters to strategy objects: ALPHA CODE USE WITH CARE}
-\arguments{\item{strategy}{}
-\item{symbol}{}
-\item{type}{}
-\item{name}{}
-\item{parameter}{}
-\item{...}{}}
+\arguments{\item{strategy}{strategy}
+\item{symbol}{symbol}
+\item{type}{type}
+\item{name}{name}
+\item{parameter}{parameter}
+\item{...}{dots}}