investor.create: Create Investor

Description Usage Arguments Value

View source: R/investor.r

Description

This function creates an investor object.

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
investor.create(
  portfolioHoldings,
  portfolioName = "",
  cashBuffers = NULL,
  horizon = 10,
  taxrate.state = 0,
  taxrate.ordinc = 0,
  taxrate.LTCG = 0,
  taxrate.STCG = 0,
  taxrate.qualdiv = 0,
  taxrate.surcharge = 0.038,
  taxrate.retirement.ordinc = NULL,
  benchmarkType = "US"
)

Arguments

portfolioHoldings

tibble with portfolio holdings

portfolioName

name of portfolio from BD

cashBuffers

tibble of portoflio cash buffers read in from BD

horizon

Time horizon in years. Default is 10.

taxrate.state

State income tax rate. Default is 0.

taxrate.ordinc

Federal tax rate on ordinary income. Default is 0.

taxrate.LTCG

Federal tax rate on long-term capital gains. Default is 0.

taxrate.STCG

Federal tax rate on short-term capital gains. Default is 0.

taxrate.qualdiv

Federal tax rate qualified dividends. Default is 0.

taxrate.surcharge

Net investment income tax rate (section 1411 of IRC). Default is 0.038.

taxrate.retirement.ordinc

Federal tax rate on ordinary income in retirment. If NULL (default) uses the taxrate.ordinc value.

benchmarkType

either "US" (default) for a U.S. centric investor, or "Global"

Value

An investor class object which is a list containing items related to the investor. This package internally calculate income and capital gain rates that combine federal, state and surcharge taxes.


rexmacey/AA2 documentation built on March 8, 2020, 5:49 a.m.