[Blotter-commits] r35 - pkg/man

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

Author: peter_carl
Date: 2008-12-23 04:01:02 +0100 (Tue, 23 Dec 2008)
New Revision: 35

Modified:
   pkg/man/initPortf.Rd
Log:
- fixed spacing
- added keywords


Modified: pkg/man/initPortf.Rd
===================================================================
--- pkg/man/initPortf.Rd	2008-12-23 03:00:14 UTC (rev 34)
+++ pkg/man/initPortf.Rd	2008-12-23 03:01:02 UTC (rev 35)
@@ -24,37 +24,40 @@
 }
 \value{
   Creates a portfolio object, which is a list of symbols that contains two xts objects within each symbol.  Each slot is named using the symbol identifier.  For each symbol, two tables are created:
-  \item{$[symbol]$txn} {irregular xts object of transactions data}
-  \item{$[symbol]$posPL} {regular xts object of positions P&L calculated from the transactions and resulting positions}
+  \item{$[symbol]$txn}{irregular xts object of transactions data}
+  \item{$[symbol]$posPL}{regular xts object of positions P&L calculated from the transactions and resulting positions}
 }
 \author{ Peter Carl }
 \note{  
 Likewise, the underlying data can be addressed using '[portfolio name]$[symbol]$txn' or  '[portfolio name]$[symbol]$posPL'
 
 The function 'initTxn' creates the data container used to store details about transactions and their resulting positions for an instrument.  The data series is an irregular time series with the following columns:
-  \item{Txn.Qty} { the quantity, usually in units of contracts, changing hands.  Positive values indicate a 'buy' transaction; negative values are used to indicate a 'sell.' }
-  \item{Txn.Price} { the price at which the transaction was made }
+\itemize{
+  \item{Txn.Qty}{ the quantity, usually in units of contracts, changing hands.  Positive values indicate a 'buy' transaction; negative values are used to indicate a 'sell.' }
+  \item{Txn.Price}{ the price at which the transaction was made }
   \item{Txn.Fees}{ the sum total of transaction fees associated with the trade}
-  \item{Txn.Value} { the notional value of the transaction }
-  \item{Avg.Txn.Cost} { a calculated value for the average net price paid (received) per contract bought (received) }
-  \item{Pos.Qty} { the resulting position quantity of contracts, calculated as the sum of the current transaction and the prior position }
-  \item{Pos.Avg.Cost} { the calculated average cost of the resulting position }
-  \item{Realized.PL} { any profit or loss realized in the transaction from closing out a prior position }
+  \item{Txn.Value}{ the notional value of the transaction }
+  \item{Avg.Txn.Cost}{ a calculated value for the average net price paid (received) per contract bought (received) }
+  \item{Pos.Qty}{ the resulting position quantity of contracts, calculated as the sum of the current transaction and the prior position }
+  \item{Pos.Avg.Cost}{ the calculated average cost of the resulting position }
+  \item{Realized.PL}{ any profit or loss realized in the transaction from closing out a prior position }
+  }
    
 Similarly, the function 'initPosPL' constructs the data container used to store calculated P&L values from  transactions and close prices within an instrument. The data series is, however, a regular time series.  Columns of the table include:
-  \item{Pos.Qty} { the quantity of the position held in the symbol}
-  \item{Pos.Value} { the notional value of the position }
-  \item{Txn.Value} { the net value of the transactions occuring }
-  \item{Txn.Fees} { the total fees associated with transactions }
-  \item{Realized.PL} { any net profit or loss realized through transactions }
-  \item{Unrealized.PL} { any profit or loss associated with the remaining or 'open' position }
-  \item{Trading.PL} { the sum of net realized and unrealized profit and loss }
-  
+\itemize{
+  \item{Pos.Qty}{ the quantity of the position held in the symbol}
+  \item{Pos.Value}{ the notional value of the position }
+  \item{Txn.Value}{ the net value of the transactions occuring }
+  \item{Txn.Fees}{ the total fees associated with transactions }
+  \item{Realized.PL}{ any net profit or loss realized through transactions }
+  \item{Unrealized.PL}{ any profit or loss associated with the remaining or 'open' position }
+  \item{Trading.PL}{ the sum of net realized and unrealized profit and loss }
+  }
 }
 \seealso{ \code{\link{addTxn}}, \code{\link{getPos}}, \code{\link{initAcct}} }
 \examples{
 }
 % Add one or more standard keywords, see file 'KEYWORDS' in the
 % R documentation directory.
-\keyword{ ~kwd1 }
-\keyword{ ~kwd2 }% __ONLY ONE__ keyword per line
+\keyword{ utilities }
+\keyword{ manip }