R/getPos.R

In cloudcell/blotter: Tools for Transaction-Oriented Trading Systems Development

#' Retrieves all information about the position as of a date
#' 
#' NOTE This could get much more complicated from here, particularly when it's conditional on symbol, etc.
#' @param Portfolio 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 have the most recent position
#' @param Columns which columns to return from the \code{txn} slot in the portfolio
#' @param n number of periods to return, default 1
#' @return All data elements related to position in a row of an xts object
#' @export
getPos <- function(Portfolio, Symbol, Date, Columns=c('Pos.Qty','Pos.Avg.Cost'),n=1)
{ # @author Peter Carl
    Portfolio<-.getPortfolio(Portfolio)    
    # FUNCTION
    PosData = Portfolio$symbols[[Symbol]]$txn
    #toDate = paste('::', Date, sep="")
    # It may not make sense to return realized P&L with the position information, so only position and 
    # position average cost are returned.
    #if(nrow(PosData)>1) Pos = last(PosData[toDate][,Columns],n=n)
    if(nrow(PosData)>1) {
        if(!inherits(Date,"POSIXct")) Date<-as.POSIXct(Date) 
        Pos = last(PosData[which(index(PosData)<=Date),][, Columns], n = n)
    } else Pos <- PosData[,Columns]
    return(Pos)
}

###############################################################################
# Blotter: Tools for transaction-oriented trading systems development
# for R (see http://r-project.org/) 
# Copyright (c) 2008-2015 Peter Carl and Brian G. Peterson
#
# This library is distributed under the terms of the GNU Public License (GPL)
# for full details see the file COPYING
#
# $Id: getPos.R 1666 2015-01-07 13:26:09Z braverock $
#
###############################################################################