Skip to main content

Pipline result processing program for the JASEN pipeline and Bonsai tool.

Project description

Pipeline result processor (prp)

A collection of parsers and data models for creation and validation of a standardized output for the jasen pipeline which is used as an input for bonsai.

[!WARNING] Bonsai-PRP is under development in an alpha stage. Expect uneven documentation, breaking changes, and bugs until the official 1.0 release.

Dependencies (latest)

  • biopython
  • pydantic=2.5.3
  • python=3.10

Using prp

Use the help argument for information regarding the prp's methods

prp --help

Use the method help argument for information regarding the input for each of prp's methods (create-bonsai-input, create-cdm-input, create-qc-result, print-schema, validate)

prp <method> --help

Create bonsai input from pipeline data

prp create-bonsai-input -i SAMPLE_ID -u RUN_METADATA_FILE -q QUAST_FILENAME -d PROCESS_METADATA_FILE -k KRAKEN_FILE -a AMRFINDER_FILE -m MLST_FILE -c CGMLST_FILE -v VIRULENCEFINDER_FILE -r RESFINDER_FILE -p POSTALIGNQC_FILE -k MYKROBE_FILE -t TBPROFILER_FILE [--correct_alleles] -o OUTPUT_FILE [-h]

Create CDM input from pipeline data

prp create-cdm-input -q QUAST_FILENAME -c CGMLST_FILE -p POSTALIGNQC_FILE [--correct_alleles] -o OUTPUT_FILE [-h]

Create QC result from bam file

prp create-qc-result -i SAMPLE_ID --b BAM_FILE [-e BED_FILE] [-a BAITS_FILE] -r REFERENCE_FILE [-c CPUS] -o OUTPUT_FILE [-h]

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

bonsai_prp-0.9.0.tar.gz (43.6 kB view hashes)

Uploaded Source

Built Distribution

bonsai_prp-0.9.0-py3-none-any.whl (51.7 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page