×

nf-core/plasmodiumdrugres

Pipeline for analyzing drug resistance markers from Plasmodium microhaplotype data. Translates variants into amino acid changes at drug resistance loci and estimates allele frequencies and prevalences at both single-locus and multi-locus levels. Microhaplotype data can be supplied in the form of an allele table or a PMO file.

Version: 0.0.0-a333327 Git revision: a333327a245ccb3c0f1a37167a7afe670c35894e Commit: Content hash:
Run:
Workflow: main.nf

nf-core/plasmodiumdrugres

Open in GitHub Codespaces GitHub Actions CI Status GitHub Actions Linting StatusAWS CICite with Zenodo nf-test

Nextflow nf-core template version run with conda run with docker run with singularity Launch on Seqera Platform

Get help on SlackFollow on BlueskyFollow on MastodonWatch on YouTube

Introduction

nf-core/plasmodiumdrugres is a bioinformatics pipeline for analyzing drug resistance markers from microhaplotype data. It translates variants into amino acid changes at drug resistance loci and estimates allele frequencies and prevalences at both single-locus and multi-locus levels. Microhaplotype data can be supplied in the form of an allele table or a PMO file.

The pipeline was developed for Plasmodium falciparum, and ships an example set of P. falciparum drug resistance loci, but it is not limited to it. It can be applied to any organism where microhaplotypes are available, given a matching reference and a BED file of the loci of interest. It would be most useful for pathogens where infections can be polyclonal and the genotype of interest is comprised of multiple variants (multilocus).

metro_map

  1. Translate loci of interest (PGEcore)
  2. Split by population
  3. Estimate allele prevalence (PGEcore)
  4. Estimate multilocus allele frequency. Choice of method between:
    1. MultiLociBiallelicModel (PGEcore wrapper script)
    2. FreqEstimationModel (PGEcore wrapper script)
    3. Naive method (PGEcore)
  5. Estimate single locus allele frequency. Choice of method between:
    1. Incomplete data model (IDM) (PGEcore wrapper script)
    2. Naive PGEcore method
    3. mhaps_freq (from microhaplotype frequencies via DCIFER)
  6. Merge prevalence and frequency outputs
  7. Concatenate population outputs into standardized summary tables, while preserving full tool-specific columns in raw_summaries/

Usage

Note

If you are new to Nextflow and nf-core, please refer to this page on how to set-up Nextflow. Make sure to test your setup with -profile test before running the workflow on actual data.

The pipeline accepts either a Portable Microhaplotype Object (PMO) or an allele table plus panel BED. You must also provide a loci of interest BED. Optionally provide loci groups for multi-locus estimates and a population assignment for multi-population runs.

Now, you can run the pipeline using a PMO:

nextflow run nf-core/plasmodiumdrugres \
   -profile <docker/singularity/.../institute> \
   --pmo input_file.pmo \
   --loci_of_interest_bed loci_of_interest.bed \
   --loci_groups loci_groups.tsv \
   --outdir <OUTDIR>

Or with an allele table:

nextflow run nf-core/plasmodiumdrugres \
   -profile <docker/singularity/.../institute> \
   --allele_table allele_table.tsv \
   --panel_info_bed panel_info.bed \
   --loci_of_interest_bed loci_of_interest.bed \
   --loci_groups loci_groups.tsv \
   --outdir <OUTDIR>

Warning

Please provide pipeline parameters via the CLI or Nextflow -params-file option. Custom config files including those provided by the -c Nextflow option can be used to provide any configuration except for parameters; see docs.

For more details and further functionality, please refer to the usage documentation and the parameter documentation.

Pipeline output

To see the results of an example test run with a full size dataset refer to the results tab on the nf-core website pipeline page. For more details about the output files and reports, please refer to the output documentation.

Main results include standardized sl_summary.tsv and ml_summary.tsv tables, plus full tool-specific concatenated tables under raw_summaries/.

Credits

nf-core/plasmodiumdrugres was originally written by PlasmoGenEpi.

We specifically thank the following people for their extensive assistance in the development of this pipeline:

  • Kathryn Murie
  • Nicholas Hathaway
  • Alfred Hubbard
  • Jorge Amaya-Romero

A special thanks to everyone in the community who contributes to PGEcore and continues to do so.

Contributions and Support

If you would like to contribute to this pipeline, please see the contributing guidelines.

For further information or help, don't hesitate to get in touch on the Slack #plasmodiumdrugres channel (you can join with this invite).

Citations

An extensive list of references for the tools used by the pipeline can be found in the CITATIONS.md file.

You can cite the nf-core publication as follows:

The nf-core framework for community-curated bioinformatics pipelines.

Philip Ewels, Alexander Peltzer, Sven Fillinger, Harshil Patel, Johannes Alneberg, Andreas Wilm, Maxime Ulysse Garcia, Paolo Di Tommaso & Sven Nahnsen.

Nat Biotechnol. 2020 Feb 13. doi: 10.1038/s41587-020-0439-x.

45 parameter(s) in 5 group(s)

Method options for pipeline steps#

Parameters used to define the methods used for each step of the pipeline.

Average complexity of infection (COI) assumed for every specimen when --mlaf_method is FEM.

More detail

FreqEstimationModel needs a COI for each specimen. The pipeline does not estimate COI, so this single value is applied to all specimens. Set it to the expected mean COI for your study population; the default of 3 is a generic assumption, not an estimate from your data.

type number
default 3

Method for multi-locus allele frequency estimates.