Skip to contents

Run specific step

Source: R/aliases.R
pipe_run_step.Rd

Run given pipeline step possibly together with upstream and/or downstream dependencies.

Usage

pipe_run_step(
  pip,
  step,
  upstream = TRUE,
  downstream = FALSE,
  cleanUnkept = FALSE
)

Arguments

pip

Pipeline object

step

string name of step

upstream

logical if TRUE, run all dependent upstream steps first.

downstream

logical if TRUE, run all depdendent downstream afterwards.

cleanUnkept

logical if TRUE all output that was not marked to be kept is removed after the pipeline run. This option can be useful if temporary results require a lot of memory.

Value

returns the Pipeline object invisibly

Examples

p <- pipe_new("pipe", data = 1)
pipe_add(p, "add1", \(x = ~data, y = 1) x + y)
pipe_add(p, "add2", \(x = ~add1, z = 2) x + z)
pipe_add(p, "mult", \(x = ~add1, y = ~add2) x * y)
pipe_run_step(p, "add2")
#> INFO  [2025-07-27 10:40:34.396] Start step run of 'pipe' pipeline:
#> INFO  [2025-07-27 10:40:34.397] Step 1/3 data (upstream)
#> INFO  [2025-07-27 10:40:34.399] Step 2/3 add1 (upstream)
#> INFO  [2025-07-27 10:40:34.402] Step 3/3 add2
#> INFO  [2025-07-27 10:40:34.403] Finished execution of steps.
#> INFO  [2025-07-27 10:40:34.404] Done.

pipe_run_step(p, "add2", downstream = TRUE)
#> INFO  [2025-07-27 10:40:34.406] Start step run of 'pipe' pipeline:
#> INFO  [2025-07-27 10:40:34.406] Step 1/4 data (upstream)
#> INFO  [2025-07-27 10:40:34.409] Step 2/4 add1 (upstream)
#> INFO  [2025-07-27 10:40:34.411] Step 3/4 add2
#> INFO  [2025-07-27 10:40:34.413] Step 4/4 mult (downstream)
#> INFO  [2025-07-27 10:40:34.415] Finished execution of steps.
#> INFO  [2025-07-27 10:40:34.416] Done.

pipe_run_step(p, "mult", upstream = TRUE)
#> INFO  [2025-07-27 10:40:34.417] Start step run of 'pipe' pipeline:
#> INFO  [2025-07-27 10:40:34.418] Step 1/4 data (upstream)
#> INFO  [2025-07-27 10:40:34.420] Step 2/4 add1 (upstream)
#> INFO  [2025-07-27 10:40:34.422] Step 3/4 add2 (upstream)
#> INFO  [2025-07-27 10:40:34.424] Step 4/4 mult
#> INFO  [2025-07-27 10:40:34.425] Finished execution of steps.
#> INFO  [2025-07-27 10:40:34.426] Done.