get_items: Gets items in the current environment

In derek-damron/budgetr: Easy budgeting in R

Description

get_items returns a list of budget items matching the specified pattern.

Usage

get_items(pattern = ".", env = parent.frame())

Arguments

pattern	A regular expression describing the names of objects to check. Defaults to all objects
env	The environment to look for items. Defaults to the calling environment.

Value

The output of create_item is a list of budget items matching the specified pattern.

Examples

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

# Get all items
get_items()

# Get only items matching "rent"
get_items("rent")

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