cl_set: Change Elements of a Checklist

In geoffwlamb/checklist: Create Checklists in RStudio

Description

This function allows you to cutsomize a checklist you've created.

Usage

cl_set(cl, ...)

Arguments

cl	A checklist object
...	Elements of checklist to update. See Details for available options. Unknown arguments will throw warnings, but recognized arguments in the same call will still be processed.

Details

Currently supported values that can be changed:

• title: New title for checklist

• tasks: New items for checklist. Overwrites any existing items. Must have consistent length with completed when updating.

• completed: New completed statuses for checklist. Overwrites any existing statuses. Must have consistent length with tasks when updating.

• sound: Logical for whether or not to make noise upon completion

• background.color: String with color value

• text.color: String with color value

• completed.color: String with color value

• font.family: String with font family (basic HTML only)

title tasks completed sound background.color text.color completed.color font.family:

Examples

# create a checlist
cl <- cl_create()

# change some style options
cl_set(cl, background.color = "blue", text.color = "white")

# add mutliple items (make sure to also update completed)
cl_set(cl, tasks = c(1,2,3), completed = c(TRUE, FALSE, FALSE))

# change items (notice that the tasks argument overwrites
# all items that are currently on the checklist)
cl_set(cl, tasks = c("item 1", "item 2"), completed = rep(FALSE, 2))

geoffwlamb/checklist documentation built on May 17, 2019, 2:59 p.m.