[Blotter-commits] r42 - pkg/man
noreply at r-forge.r-project.org
noreply at r-forge.r-project.org
Tue Dec 30 16:29:20 CET 2008
Author: peter_carl
Date: 2008-12-30 16:29:20 +0100 (Tue, 30 Dec 2008)
New Revision: 42
Modified:
pkg/man/addTxn.Rd
pkg/man/getEndEq.Rd
pkg/man/initPortf.Rd
Log:
- fixed latex errors
Modified: pkg/man/addTxn.Rd
===================================================================
--- pkg/man/addTxn.Rd 2008-12-30 04:34:11 UTC (rev 41)
+++ pkg/man/addTxn.Rd 2008-12-30 15:29:20 UTC (rev 42)
@@ -12,7 +12,6 @@
\usage{
addTxn(Portfolio, Symbol, TxnDate, TxnQty, TxnPrice, TxnFees = 0, verbose = TRUE)
}
-%- maybe also 'usage' for other objects documented here.
\arguments{
\item{Portfolio}{ a portfolio object structured with \code{\link{initPortf}} }
\item{Symbol}{ an instrument identifier for a symbol included in the portfolio, e.g., "IBM" }
@@ -26,7 +25,7 @@
This function will eventually also handle other transaction types, such as adjustments for corporate actions or expire/assign for options.
}
\value{
- Returns the entire portfolio object with the additional transaction in the correct slot: Portfolio[[Symbol]]$txn
+ Returns the entire portfolio object with the additional transaction in the correct slot: \code{Portfolio[[Symbol]]$txn}.
}
\author{ Peter Carl }
\note{
Modified: pkg/man/getEndEq.Rd
===================================================================
--- pkg/man/getEndEq.Rd 2008-12-30 04:34:11 UTC (rev 41)
+++ pkg/man/getEndEq.Rd 2008-12-30 15:29:20 UTC (rev 42)
@@ -12,7 +12,7 @@
\item{Date}{ an ISO 8601 date, such as '2008-01-05' }
}
\details{
- Retrieves the value from the \kbd{TOTAL} slot of the Account object. Use \kbd{[Account object name]$TOTAL} to review the xts table of calculated data.
+ Retrieves the value from the \code{TOTAL} slot of the Account object. Use \code{[Account object name]$TOTAL} to review the xts table of calculated data.
}
\value{
Numeric value of the equity account for the date given
Modified: pkg/man/initPortf.Rd
===================================================================
--- pkg/man/initPortf.Rd 2008-12-30 04:34:11 UTC (rev 41)
+++ pkg/man/initPortf.Rd 2008-12-30 15:29:20 UTC (rev 42)
@@ -29,7 +29,7 @@
}
\author{ Peter Carl }
\note{
-Likewise, the underlying data can be addressed using '[portfolio name]$[symbol]$txn' or '[portfolio name]$[symbol]$posPL'
+Likewise, the underlying data can be addressed using \code{[portfolio name]$[symbol]$txn} or \code{[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:
\itemize{
More information about the Blotter-commits
mailing list