Document a decision — log_decision • justifier

Used to programmatically document decisions - note that you have to store them to a file to not lose them (i.e. if used interactively).

Usage

log_decision(
  label,
  description = "",
  alternatives = "",
  date = as.character(Sys.Date()),
  id = NULL,
  justification = "",
  silent = justifier::opts$get("silent"),
  ...
)

Arguments

label: A human-readable label for the decision,
description: A human-readable description.
alternatives: The alternatives between which was chosen.
date: The date of the decision.
id: Optionally, a manually specified id (otherwise, randomly generated).
justification: A justification specified using jstf(), or more than one, combined with the c operator.
silent: Whether to print messages.
...: Any additional options will be stored in the decision.

Value

Invisibly, the decision as a justifier object (generated by dcsn()).

Examples

clean_workspace(force = TRUE, silent=FALSE);
#> Your justifier workspace has been cleaned and is now empty.
log_decision("First we start using `justifier`.",
             silent=FALSE);
#> Added new decision with identifier 'vmqe_D7n8bpc4x' to a justifier workspace that already contained 0 justifications.
log_decision(paste0("Then we start documenting our ",
                    "decisions and justifications."),
             silent=FALSE);
#> Added new decision with identifier 'yeil_D7n8bpc4y' to a justifier workspace that already contained 1 justifications.
log_decision("Then we start learning from ourselves.",
             silent=FALSE);
#> Added new decision with identifier 'hkdb_D7n8bpc4y' to a justifier workspace that already contained 2 justifications.
workspace();
#> A list of 3 justifier elements of type justifierDecision and with identifiers 'vmqe_D7n8bpc4x', 'yeil_D7n8bpc4y' & 'hkdb_D7n8bpc4y'