Package index • pipeflow

Getting started

Create a pipeline, add steps, and collect results.

pipeflow pipeflow-package: pipeflow: Fast Interactive Data Analysis Pipelines
pip_new(): Create a pipeline
pip_add(): Add a step
pip_collect() pip_collect_out(): Collect step outputs

Modify steps

Replace, rename, remove, reset, or re-configure steps.

pip_replace(): Replace a step
pip_rename(): Rename a step
pip_remove(): Remove a step
pip_reset(): Reset a pipeline to its initial state
pip_get_params() pip_set_params(): Get or set unbound parameters

Pipeline composition

Combine or clone pipelines.

rbind(<pipeflow>): Bind pipelines
pip_clone(): Clone a pipeline

Running pipelines

Execute pipeline steps or views.

pip_run(): Run a pipeline
pip_run_state(): Get the run state of a pipeline
pip_param_value(): Unwrap a parameter value before a step function is called
pipeflow_lgr(): Default logger of pipeflow

Locking and tagging

Lock steps against changes or tag them for filtering.

pip_lock() pip_unlock(): Lock or unlock steps
pip_tag() pip_untag(): Add or remove tags

Inspection and views

Inspect the pipeline structure, access the step table, and create filtered views.

pip_view(): Create a pipeline view
pip_data(): Access the underlying step table
pip_graph() pip_get_graph(): Build pipeline graph data

Extract and replace operators

Subset, read from and write to a pipeline using base R operators.

`[`(<pipeflow>) `[[`(<pipeflow>) `[[<-`(<pipeflow>) `[<-`(<pipeflow>) `$`(<pipeflow>) `$<-`(<pipeflow>): Extract or replace parts of a pipeline

S3 methods

Generic methods for pipeflow objects.

length(<pipeflow>) dim(<pipeflow>): Dimensions of a pipeflow pipeline or view
str(<pipeflow>) print(<pipeflow>): Print pipeflow objects

Filtering helpers

Filter operators from data.table re-exported for use in view and subset expressions.

pipeflow-operators %like% %ilike% %flike% %plike% %chin% %between% %inrange% %notin%: Row-filter operators re-exported from data.table