[Blotter-commits] r487 - pkg/blotter/R

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

Author: peter_carl
Date: 2010-12-10 19:15:44 +0100 (Fri, 10 Dec 2010)
New Revision: 487

Modified:
   pkg/blotter/R/getTxn.R
Log:
- doc changes


Modified: pkg/blotter/R/getTxn.R
===================================================================
--- pkg/blotter/R/getTxn.R	2010-12-09 16:18:02 UTC (rev 486)
+++ pkg/blotter/R/getTxn.R	2010-12-10 18:15:44 UTC (rev 487)
@@ -1,4 +1,10 @@
-#' Gets the transactions and returns 
+#' Retrieves the transactions and their attributes.
+#'
+#' Find and return the transactions and attribute values for the symbol and date in a specified portfolio.
+#' 
+#' This function provides easy access to the values of transactions contained in a Portfolio object. See initPortf for a detailed description of the structure of a Portfolio object.
+#'
+#'
 #' @param Portfolio a string identifying a portfolio object containing transactions
 #' @param Symbol an instrument identifier for a symbol included in the portfolio
 #' @param Date timestamp as of which to get transactions