[Blotter-commits] r21 - pkg/man

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

Author: peter_carl
Date: 2008-12-17 15:33:14 +0100 (Wed, 17 Dec 2008)
New Revision: 21

Removed:
   pkg/man/getRealizedPL.Rd
Log:
- removed, using alias in getTxn.Rd


Deleted: pkg/man/getRealizedPL.Rd
===================================================================
--- pkg/man/getRealizedPL.Rd	2008-12-17 14:32:38 UTC (rev 20)
+++ pkg/man/getRealizedPL.Rd	2008-12-17 14:33:14 UTC (rev 21)
@@ -1,64 +0,0 @@
-\name{getRealizedPL}
-\alias{getRealizedPL}
-%- Also NEED an '\alias' for EACH other topic documented here.
-\title{ ~~function to do ... ~~ }
-\description{
-  ~~ A concise (1-5 lines) description of what the function does. ~~
-}
-\usage{
-getRealizedPL(Portfolio, Symbol, Date)
-}
-%- maybe also 'usage' for other objects documented here.
-\arguments{
-  \item{Portfolio}{ ~~Describe \code{Portfolio} here~~ }
-  \item{Symbol}{ ~~Describe \code{Symbol} here~~ }
-  \item{Date}{ ~~Describe \code{Date} here~~ }
-}
-\details{
-  ~~ If necessary, more details than the description above ~~
-}
-\value{
-  ~Describe the value returned
-  If it is a LIST, use
-  \item{comp1 }{Description of 'comp1'}
-  \item{comp2 }{Description of 'comp2'}
-  ...
-}
-\references{ ~put references to the literature/web site here ~ }
-\author{ ~~who you are~~ }
-\note{ ~~further notes~~ 
-
- ~Make other sections like Warning with \section{Warning }{....} ~
-}
-\seealso{ ~~objects to See Also as \code{\link{help}}, ~~~ }
-\examples{
-##---- Should be DIRECTLY executable !! ----
-##-- ==>  Define data, use random,
-##--	or do  help(data=index)  for the standard data sets.
-
-## The function is currently defined as
-function(Portfolio, Symbol, Date)
-{ # @author Peter Carl
-
-    # DESCRIPTION:
-    # Retrieves realized PL for a period
-
-    # Inputs
-    # Portfolio: a portfolio object containing transactions
-    # Symbol: an instrument identifier for a symbol included in the portfolio
-    # Date: date for which to get realized PL.  Use xts subsetting for best 
-    # results, e.g., '1980-01-01' for a whole day, '1980-01' for a month
-
-    # Outputs
-    # Realized PL calculated for the transaction
-
-    # FUNCTION
-    PosData = Portfolio[[Symbol]]$txn
-    RealizedPL = sum(as.numeric(PosData[Date, 'Realized.PL', drop=FALSE]))
-    return(RealizedPL)
-  }
-}
-% Add one or more standard keywords, see file 'KEYWORDS' in the
-% R documentation directory.
-\keyword{ ~kwd1 }
-\keyword{ ~kwd2 }% __ONLY ONE__ keyword per line