Skip to contents

Change Step Rationale

changeStepRationale.Rd

Modifies the rationale field of an existing step, allowing users to update the reasoning and justification for why analytical steps were created and included in the workflow.

Usage

changeStepRationale(ident, from = pwd(), rationale)

Arguments

ident

Identifier of the step. Can be the step's path, resource (version) id, full entity (version) id, or short entity (version) id.

from

Root directory for resolving relative paths. Default is pwd().

rationale

New step rationale text.

Value

The updated step resource, returned invisibly after cache refresh.

References

ics1217

See also

changeStepDescription for updating step description, getStep for retrieving step information

Examples

if (FALSE) { # \dontrun{
# Update step rationale
changeStepRationale(
  ident = "/improve-tutorial/Modeling/Step 1",
  rationale = "Investigate linear relationship between variables"
)
} # }