×

nf-core/pathogenepidemiology

[DEVELOPMENT UNDERWAY] A profile-based pipeline for genomic epidemiological analysis of predefined pathogens.

Version: 0.0.0-8261242 Git revision: 8261242100b6f4474466a709bd439622768bd098 Commit: Content hash:
Run:
Workflow: main.nf

nf-core/pathogenepidemiology

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/pathogenepidemiology is a bioinformatics pipeline that ...

1. Read QC ([`FastQC`](https://www.bioinformatics.babraham.ac.uk/projects/fastqc/))2. Present QC for raw reads ([`MultiQC`](http://multiqc.info/))

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.

Now, you can run the pipeline using:

nextflow run nf-core/pathogenepidemiology \
   -profile <docker/singularity/.../institute> \
   --input samplesheet.csv \
   --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.

Pipeline input

To run this pipeline, you will need a reference genome for both your pathogen of interest, and its host.

We will patch this out before release, but pathogenepidemiology developers can get reference genome data with:


QUERY_GENOME="https://ftp.ebi.ac.uk/ensemblgenomes/pub/protists/release-62/fasta/plasmodium_falciparum/dna/Plasmodium_falciparum.GCA000002765v3.dna.toplevel.fa.gz"
HOST_GENOME="https://ftp.ebi.ac.uk/ensemblgenomes/pub/metazoa/release-62/fasta/anopheles_gambiae/dna/Anopheles_gambiae.AgamP4.dna.toplevel.fa.gz"

nextflow run workflows/download_references.nf -profile docker --validation_monochromeLogs false --queryurl $QUERY_GENOME --hosturl $HOST_GENOME

Credits

nf-core/pathogenepidemiology was originally written by Igiraneza Clement, Bilal Asser, Firas Zemzem, more tbc.

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

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 #pathogenepidemiology 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.

29 parameter(s) in 4 group(s)

Generic options#

Less common options for the pipeline, typically set in a config file.

Display the help message.

type [boolean, string]

Display version and exit.

type boolean

Display the full detailed help message.

type boolean

Display hidden parameters in the help message (only works when --help or --help_full are provided).

type boolean

Email address for completion summary, only when pipeline fails.

More detail

An email address to send a summary email to when the pipeline is completed - ONLY sent if the pipeline does not exit successfully.

type string
pattern ^([a-zA-Z0-9_\-\.]+)@([a-zA-Z0-9_\-\.]+)\.([a-zA-Z]{2,5})$

Custom config file to supply to MultiQC.

type string

Do not use coloured log outputs.

type boolean

Send plain-text email instead of HTML.

type boolean