log_decision: Document a decision

In justifier: Human and Machine-Readable Justifications and Justified Decisions Based on 'YAML'

Document a decision

Description

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);
log_decision("First we start using `justifier`.",
             silent=FALSE);
log_decision(paste0("Then we start documenting our ",
                    "decisions and justifications."),
             silent=FALSE);
log_decision("Then we start learning from ourselves.",
             silent=FALSE);
workspace();

justifier documentation built on March 7, 2023, 6:59 p.m.