Skip to contents

Change Step Description

changeStepDescription.Rd

Modifies the description field of an existing step, allowing users to update documentation and clarify the purpose of analytical steps as analyses evolve.

Usage

changeStepDescription(ident, from = pwd(), description)

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().

description

New step description text.

Value

The updated step resource, returned invisibly after cache refresh.

References

ics1217

See also

changeStepRationale for updating step rationale, getStep for retrieving step information

Examples

if (FALSE) { # \dontrun{
# Update step description
changeStepDescription(
  ident = "/improve-tutorial/Modeling/Step 1",
  description = "Initial exploratory analysis"
)
} # }