show_steps: Show all steps of a SCC model

show_stepsR Documentation

Show all steps of a SCC model

Description

Prints all steps that are part of a sufficient-component cause model. The function wraps sc_contain_steps() with steps = NULL.

Usage

show_steps(scc, output = c("nice", "table"))

Arguments

scc

An object of class epicmodel_scc.

output

A single element of type character, either "nice" (default) or "table". If "table", returns a data.frame. If "nice", a nicely formated output is printed in the console.

Value

Either a data.frame (output = "table") with variables id_step (step ID) and desc_step (step description) and one row for every step in the model, i.e., from the epicmodel_steplist_checked data.frame step, or a nicely formated output in the console (output = "nice").

Examples

# Create some SCC model
steplist_checked <- check_steplist(steplist_rain)
scc_model <- create_scc(steplist_checked)

# Show all steps
show_steps(scc_model)

epicmodel documentation built on April 12, 2025, 1:59 a.m.