Pypiper is simple, but powerful. You really only need to know about 3 functions to get started.
PipelineManager can do:
||The primary workhorse function of PipelineManager, this runs a command.|
||Terminate the pipeline.|
With those 3 functions, you can create a simple pipeline. Click on each function to view its in-depth documentation. There are quite a few optional parameters to the
run function, which is where most of Pypiper’s power comes from.
When you’ve mastered the basics and are ready to get more powerful, add in a few new (optional) commands that make debugging and development easier:
||Print message, time, and time elapsed, perhaps creating checkpoint.|
||Writes a string to self.pipeline_stats_file.|
||Add files (or regexs) to a cleanup list, to delete when this pipeline completes successfully.|
||Returns a stat that was previously reported.|
The complete documentation for these functions can be found in the API.