Package index • pipeflow

Pipeline

A pipeline is created by instantiating an object of the Pipeline class. Follow the Pipeline link below for a detailed documenation of all member functions provided by a Pipeline object.

Pipeline: Pipeline Class

Alias functions

There is one alias function for each member function of a Pipeline object. It starts with pipe_ followed by the name of the resepective member function.

Basic usage

These functions are required for basic usage and also likely the most frequently used functions. Further down below you find all functions categorized by type of functionality.

pipe_new(): Create new pipeline

pipe_add(): Add pipeline step

pipe_set_data(): Set data

pipe_set_params(): Set pipeline parameters

pipe_run(): Run pipeline

pipe_get_out(): Get output of given step

pipe_collect_out(): Collect output from entire pipeline

Create

pipe_new(): Create new pipeline

pipe_clone(): Clone pipeline

Change

pipe_append_to_step_names(): Append string to all step names

pipe_replace_step(): Replace pipeline step

pipe_rename_step(): Rename step

pipe_reset(): Reset pipeline

Add, append, insert

pipe_add(): Add pipeline step

pipe_append(): Append two pipelines

pipe_insert_after() pipe_insert_before(): Insert step

Get

pipe_get_data(): Get data

pipe_get_depends() pipe_get_depends_down() pipe_get_depends_up(): Get step dependencies

pipe_get_graph(): Pipeline graph

pipe_get_out(): Get output of given step

pipe_get_params() pipe_get_params_at_step() pipe_get_params_unique() pipe_get_params_unique_json(): Get pipeline parameters

pipe_get_step() pipe_get_step_names() pipe_get_step_number() pipe_has_step(): Get step information

Information

pipe_length(): Length of the pipeline

Output

pipe_collect_out(): Collect output from entire pipeline

pipe_print(): Print the pipeline as a table

Remove

pipe_discard_steps(): Discard steps from the pipeline

pipe_pop_step() pipe_pop_steps_after() pipe_pop_steps_from(): Pop steps from the pipeline

pipe_remove_step(): Remove certain step from the pipeline.

Run

pipe_run(): Run pipeline

pipe_run_step(): Run specific step

Set

pipe_lock_step() pipe_unlock_step(): Lock steps

pipe_set_data(): Set data

pipe_set_keep_out(): Change output flag

pipe_set_params(): Set pipeline parameters

pipe_set_params_at_step(): Set parameters at step

Split

pipe_set_data_split(): Split-multiply pipeline by list of data sets

pipe_split(): Split-up pipeline

Logging

set_log_layout(): Set pipeflow log layout