dividend: Create Dividend Helper function

Description Usage Arguments Value Examples

View source: R/Income.R

Description

Function to create a dividend income type

Usage

1
dividend(date, symbol, quantity, dividend, amount, desc = "")

Arguments

date

date of dividend. Date type

symbol

symbol ticker. character type

quantity

number of shares. numeric type

dividend

dividend per share. numeric type

amount

dollar amount. numeric type

desc

optional description of dividend. string type

Value

valid income object

Examples

1
dividend(Sys.Date(), symbol = "SPY", quantity = 10, dividend = 2, amount = 20)

chrishaarstick/madstork documentation built on Jan. 3, 2022, 8:34 p.m.