create_item: Creates a budget item

In derek-damron/budgetr: Easy budgeting in R

Description

create_item returns a budget item.

Usage

create_item(name, amount, day, recurring)

Arguments

name	The name describing the budget item.
amount	The amount associated with the budget item. Positive values result in addition and negative values result in subtraction.
day	The day associated with the budget item. See Details for more information.
recurring	The frequency of recurrence for the budget item. See Details for more information.

Details

day

The day argument must be one of the following types:

• A Date object

• A character or numeric object that can be converted by lubridate's ymd function.

recurring

No recurring argument means that the item is one-time (the default). If provided, recurring must be one of the following values:

• "daily" or "1 day" (recur every day)

• "X days" (recur every X days)

• "weekly" or "1 week" (recur every week)

• "X weeks" (recur every X weeks)

• "monthly" or "1 month" (recur every month)

• "X months" (recur every X months)

• "yearly" or "1 year" (recur every year)

• "X years" (recur every X years)

Value

The output of create_item is a budget item.

Examples

# Create a paycheck item
paycheck <- create_item( name = "Paycheck"
                       , amount = 1000
                       , day = "2016-01-01"
                       , recurring = "monthly"
                       )
# Inspect
paycheck

derek-damron/budgetr documentation built on Aug. 11, 2020, 2:41 a.m.