update_schedule: Updates a budget schedule

Description Usage Arguments Value Examples

View source: R/update_schedule.R

Description

update_schedule returns an updated budget schedule.

Usage

1
update_schedule(schedule, add, remove)

Arguments

schedule

The budget schedule to be updated.

add

A list of budget items to add to the schedule.

remove

A list of budget items to remove from the schedule.

Value

The output of update_schedule is a new budget schedule with the specified updates.

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
# 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"
                   )

# Create a schedule
my_schedule <- create_schedule(paycheck, rent)
# Inspect
my_schedule

# Add an internet item to the schedule
internet <- create_item( name = "Internet"
                       , amount = -100
                       , day = "2016-01-15"
                       , recurring = "monthly"
                       )
my_schedule <- update_schedule(my_schedule, add=internet)
# Inspect
my_schedule

# Remove the internet item from the schedule
my_schedule <- update_schedule(my_schedule, remove=internet)
# Inspect
my_schedule

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