[Blotter-commits] r323 - in pkg/quantstrat: . man

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

Author: braverock
Date: 2010-04-07 22:21:52 +0200 (Wed, 07 Apr 2010)
New Revision: 323

Added:
   pkg/quantstrat/man/add.paramLookupTable.Rd
   pkg/quantstrat/man/add.parameter.Rd
   pkg/quantstrat/man/getParams.Rd
   pkg/quantstrat/man/paramLookup.Rd
Modified:
   pkg/quantstrat/DESCRIPTION
   pkg/quantstrat/NAMESPACE
   pkg/quantstrat/man/sigComparison.Rd
Log:
- doc and exports updates

Modified: pkg/quantstrat/DESCRIPTION
===================================================================
--- pkg/quantstrat/DESCRIPTION	2010-04-07 17:21:18 UTC (rev 322)
+++ pkg/quantstrat/DESCRIPTION	2010-04-07 20:21:52 UTC (rev 323)
@@ -10,4 +10,4 @@
 Description: Specify, build, and back-test quantitative financial trading and portfolio strategies
 LazyLoad: yes
 License: GPL-3
-Collate: 'indicators.R' 'match.names.R' 'orders.R' 'rules.R' 'signals.R' 'strategy.R' 'traderules.R'
+Collate: 'indicators.R' 'match.names.R' 'orders.R' 'parameters.R' 'rules.R' 'signals.R' 'strategy.R' 'traderules.R'

Modified: pkg/quantstrat/NAMESPACE
===================================================================
--- pkg/quantstrat/NAMESPACE	2010-04-07 17:21:18 UTC (rev 322)
+++ pkg/quantstrat/NAMESPACE	2010-04-07 20:21:52 UTC (rev 323)
@@ -8,6 +8,8 @@
 export(updateOrders)
 export(updateOrderMatrix)
 export(ruleOrderProc)
+export(add.parameter)
+export(add.paramLookupTable)
 export(add.rule)
 export(applyRules)
 export(add.signal)

Added: pkg/quantstrat/man/add.paramLookupTable.Rd
===================================================================
--- pkg/quantstrat/man/add.paramLookupTable.Rd	                        (rev 0)
+++ pkg/quantstrat/man/add.paramLookupTable.Rd	2010-04-07 20:21:52 UTC (rev 323)
@@ -0,0 +1,4 @@
+\name{add.paramLookupTable}
+\alias{add.paramLookupTable}
+\title{add.paramLookupTable}
+\usage{add.paramLookupTable(strategy, type, name, paramTable)}


Property changes on: pkg/quantstrat/man/add.paramLookupTable.Rd
___________________________________________________________________
Name: svn:keywords
   + Revision Id Date Author

Added: pkg/quantstrat/man/add.parameter.Rd
===================================================================
--- pkg/quantstrat/man/add.parameter.Rd	                        (rev 0)
+++ pkg/quantstrat/man/add.parameter.Rd	2010-04-07 20:21:52 UTC (rev 323)
@@ -0,0 +1,5 @@
+\name{add.parameter}
+\alias{add.parameter}
+\title{add.parameter}
+\usage{add.parameter(strategy, type=c("indicator", "signal"), add.to.name, method=c("lookup", "lookup.range", "calc"), arguments, label, ...,
+    store=FALSE)}


Property changes on: pkg/quantstrat/man/add.parameter.Rd
___________________________________________________________________
Name: svn:keywords
   + Revision Id Date Author

Added: pkg/quantstrat/man/getParams.Rd
===================================================================
--- pkg/quantstrat/man/getParams.Rd	                        (rev 0)
+++ pkg/quantstrat/man/getParams.Rd	2010-04-07 20:21:52 UTC (rev 323)
@@ -0,0 +1,9 @@
+\name{getParams}
+\alias{getParams}
+\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}{}}


Property changes on: pkg/quantstrat/man/getParams.Rd
___________________________________________________________________
Name: svn:keywords
   + Revision Id Date Author

Added: pkg/quantstrat/man/paramLookup.Rd
===================================================================
--- pkg/quantstrat/man/paramLookup.Rd	                        (rev 0)
+++ pkg/quantstrat/man/paramLookup.Rd	2010-04-07 20:21:52 UTC (rev 323)
@@ -0,0 +1,4 @@
+\name{paramLookup}
+\alias{paramLookup}
+\title{paramLookup}
+\usage{paramLookup(strategy, symbol, type, name, parameter, ...)}


Property changes on: pkg/quantstrat/man/paramLookup.Rd
___________________________________________________________________
Name: svn:keywords
   + Revision Id Date Author

Modified: pkg/quantstrat/man/sigComparison.Rd
===================================================================
--- pkg/quantstrat/man/sigComparison.Rd	2010-04-07 17:21:18 UTC (rev 322)
+++ pkg/quantstrat/man/sigComparison.Rd	2010-04-07 20:21:52 UTC (rev 323)
@@ -6,8 +6,10 @@
 \details{Currently, this function compares two columns.  
 Patches to compare an arbitrary number of columns would be gladly accepted.
 
-Comparison will be applied from the first to the second column in the \code{columns} vector.}
+Comparison will be applied from the first to the second column in the \code{columns} vector.
+
+Relationship 'op' means 'opposite' side.  Reasonable attempt will be made to match.}
 \arguments{\item{label}{text label to apply to the output}
 \item{data}{data to apply comparison to}
 \item{columns}{named columns to apply comparison to}
-\item{relationship}{one of c("gt","lt","eq","gte","lte") or reasonable alternatives}}
+\item{relationship}{one of c("gt","lt","eq","gte","lte","op") or reasonable alternatives}}