get_income_stream: Get historical income information from a security

Description Usage Arguments Value

View source: R/get_income_stream.R

Description

Pull the income information (including dividends) from a security for a given period of time and a given starting investment amount. The returned information will give information about the income stream from reinvestment separately.

Usage

1
get_income_stream(sym, orig_date = today() - years(10), orig_amount = 1000)

Arguments

sym

a character vector with ticker symbols

orig_date

starting date of the investment

orig_amount

starting investment amount

Value

a list where each element is a data.table containing income information


David-Statistics/djmisc documentation built on Jan. 1, 2022, 4:04 p.m.