Remove a step

If other steps depend on the step to be removed, an error is given and the removal is blocked, unless recursive was set to TRUE. In recursive mode, the selected step and all downstream dependent steps are removed together.

Usage

pip_remove(x, step, recursive = FALSE)

Arguments

x

A pipeflow pip

step

string the name of the step to be removed.

recursive

logical if TRUE the step is removed together with all its downstream dependencies.

Value

The updated pipeline, invisibly.

Examples

p <- pip_new() |>
  pip_add("load", \(x = 1) x) |>
  pip_add("transform", \(x = ~load) x * 2) |>
  pip_add("model", \(x = ~transform) x + 10)

# Removing a leaf step (nothing depends on it) works directly
pip_remove(p, "model")
p                        # "load", "transform"
#> <pipeflow_pip> pipe (2 steps)
#> -----------------------------
#>         step depends    out state
#> 1:      load         [NULL]   new
#> 2: transform    load [NULL]   new

# Trying to remove a step that others depend on raises an error:
# pip_remove(p, "load")  # Error!

# recursive = TRUE removes the step and all its downstream dependents
pip_remove(p, "load", recursive = TRUE)
#> Removing step 'load' and its downstream dependencies: 'transform'
p                        # pipeline is now empty
#> <pipeflow_pip> pipe (0 steps)
#> -----------------------------
#> Empty data.table (0 rows and 4 cols): step,depends,out,state