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

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

Author: opentrades
Date: 2012-10-04 00:22:38 +0200 (Thu, 04 Oct 2012)
New Revision: 1210

Modified:
   pkg/quantstrat/R/orders.R
   pkg/quantstrat/man/addOrder.Rd
Log:
some small textual improvements to addOrder doc



Modified: pkg/quantstrat/R/orders.R
===================================================================
--- pkg/quantstrat/R/orders.R	2012-10-03 22:16:35 UTC (rev 1209)
+++ pkg/quantstrat/R/orders.R	2012-10-03 22:22:38 UTC (rev 1210)
@@ -135,7 +135,7 @@
 #'  
 #' We have modeled a 'limit' order, used to enter or exit a position at a specific price, determined by the
 #' prefered price (see \code{prefer}) plus \code{threshold} (see below).
-
+#' 
 #' We have modeled two types of stop orders, which should be sufficient to model most types of stops.  
 #' 
 #' We have modeled the simplest type, a 'stoplimit' order, which is just a limit order used to enter 
@@ -165,9 +165,8 @@
 #' confirmation of the previous trade and entering the new order into the order book.
 #'  
 #' The 'limit', 'stoplimit', 'stoptrailing' and 'iceberg' order types are the only order types that make
-#' use of the order \code{threshold}. Thresholds may be specified in one of 2 ways:
-#' - as a scalar (\code{tmult=FALSE}) or
-#' - as a multiplier for the current price (\code{tmult=TRUE})
+#' use of the order \code{threshold}. Thresholds may be specified in one of 2 ways: as a scalar (\code{tmult=FALSE})
+#' or as a multiplier for the current price (\code{tmult=TRUE}).
 #' The threshold is then added to the prefered order price upon order entry. The correct sign for the threshold
 #' (pos or neg, ie. add or subtract) is automagically figured out from the order side and the order quantity (buy or sell);
 #' if the user provides the wrong sign for the threshold, then it will be reversed. In other words, the user may

Modified: pkg/quantstrat/man/addOrder.Rd
===================================================================
--- pkg/quantstrat/man/addOrder.Rd	2012-10-03 22:16:35 UTC (rev 1209)
+++ pkg/quantstrat/man/addOrder.Rd	2012-10-03 22:22:38 UTC (rev 1210)
@@ -92,9 +92,11 @@
   We have modeled a 'limit' order, used to enter or exit a
   position at a specific price, determined by the prefered
   price (see \code{prefer}) plus \code{threshold} (see
-  below). We have modeled two types of stop orders, which
-  should be sufficient to model most types of stops.
+  below).
 
+  We have modeled two types of stop orders, which should be
+  sufficient to model most types of stops.
+
   We have modeled the simplest type, a 'stoplimit' order,
   which is just a limit order used to enter or exit a
   position at a specific price, determined by the prefered
@@ -139,11 +141,11 @@
   The 'limit', 'stoplimit', 'stoptrailing' and 'iceberg'
   order types are the only order types that make use of the
   order \code{threshold}. Thresholds may be specified in
-  one of 2 ways: - as a scalar (\code{tmult=FALSE}) or - as
-  a multiplier for the current price (\code{tmult=TRUE})
-  The threshold is then added to the prefered order price
-  upon order entry. The correct sign for the threshold (pos
-  or neg, ie. add or subtract) is automagically figured out
+  one of 2 ways: as a scalar (\code{tmult=FALSE}) or as a
+  multiplier for the current price (\code{tmult=TRUE}). The
+  threshold is then added to the prefered order price upon
+  order entry. The correct sign for the threshold (pos or
+  neg, ie. add or subtract) is automagically figured out
   from the order side and the order quantity (buy or sell);
   if the user provides the wrong sign for the threshold,
   then it will be reversed. In other words, the user may