rnalysis.fastq.PairedEndPipeline.export_pipeline

PairedEndPipeline.export_pipeline(filename: str | Path | None) → None | str

Export a Pipeline to a Pipeline YAML file or YAML-like string.

Function parameters are converted into their closest YAML equivalent before saving: numpy scalars and arrays become plain Python numbers and lists, and pathlib Paths become strings. Note that YAML has no tuple type - tuples are therefore saved (and re-loaded) as lists, except for the top-level tuple of positional arguments, which is restored on import.

Parameters:

filename (str, pathlib.Path, or None) – filename to save the Pipeline YAML to, or None to return a YAML-like string instead.

Returns:

if filename is None, returns the Pipeline YAML-like string.