-
Notifications
You must be signed in to change notification settings - Fork 9
/
extractTxns.Rd
32 lines (30 loc) · 1.06 KB
/
extractTxns.Rd
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
% Generated by roxygen2 (4.0.2): do not edit by hand
\name{extractTxns}
\alias{extractTxns}
\title{Extract transactions from a portfolio}
\usage{
extractTxns(Portfolio)
}
\arguments{
\item{Portfolio}{string identifying the portfolio to extract from}
}
\value{
String vector of \code{\link{addTxn}} calls that would replicate the given portfolio.
}
\description{
This function reverse-engineers \code{\link{addTxn}} calls for all the
transactions in \code{Portfolio}.
This is the fundamental task required to create a reproducible example,
as it would replicate the state of the $txn slot in the portfolio
after each \code{addTxn} call.
}
\details{
While market data, expected results, portfolio and account setup, etc, are also required,
these can usually be deduced or equivalent formulations can be found.
For transactions, only the exact \code{addTxn} parameters will recreate the $txn slot.
This function creates that reproducibility, since the result (stored in 'x')
can be used to regenerate transactions with \code{eval(parse(text=x))}.
}
\author{
Brian G. Peterson, Josh Ulrich
}