check_progress: Check Project Progress

In domjarkey/crunchscripts: Easily Manage Ad-Hoc and Recurring Crunch Projects in R

Description

Displays a list of project check points with items coloured green if the checkpoint criterion is met, and red otherwise. Check points should be set out as a named list or nested lists of logical expressions captured using the `~` (tilde) operator, and should be defined as an option in the .onLoad function of a project package using options.

Usage

check_progress(item = NULL, checklist = getOption("cs_checklist",
  default = NULL), name = getOption("cs_script_name", default =
  "Progress"))

Arguments

item	An optional vector of integers and/or characters indicating an item or sublist of the checklist to check. See examples.
checklist	A named list (or list of lists) of captured logical expressions to be evaluated. By default the cs_checklist option is used if one has been set.
name	A character string to display as the title. By default the cs_projname option is used if one has been set, or "Progress" otherwise.

Value

Returns a logical (invisibly), TRUE if all items on the check list are satisfied or FALSE otherwise.

domjarkey/crunchscripts documentation built on June 6, 2019, 7:43 p.m.