Welcome! This pipeline is currently a work in progress. I developed this pipeline as part of a Student Worksite Experience Project (SWEP) internship at Centers for Disease Control (sponsored by Leidos) in summer of 2023. This pipeline has been prototyped around detection of Escherichia coli from human metagenome samples, with plans to expand to full detection of all ESKAPEE pathogens. Please read below for planned updates, as well as pipeline premise and other information.
- Update args for passing in Kraken2 database
- Add additional ARG detection tools
- Create condensed report from ARG tool results
- Expand gene set to include other ESKAPEE pathogens
- Convert drep module to subworkflow
- Add additional functionality to accept WGS isolates in addition to metagenomes
The ESKAPEE pathogens, an acronym for Enterococcus faecium, Staphylococcus aureus, Klebsiella pneumoniae, Acinetobacter baumannii, Pseudomonas aeruginosa, Enterobacter species, and Escherichia coli pose significant global threats to human health. These pathogens may be antibiotic and treatment-resistant, and are frequently found in hospital and medical settings as infections of ports, catheters, and wounds. Identification of ESKAPEE pathogens may be challenging, as they frequently appear as commensals in the normal human microbiome, making distinction of pathogenic strains difficult. ESKAPEE pathogens may also be difficult to culture in the lab, or may lose virulence in culture, complicating their identification via traditional culture and PCR methods.
nf-core/eskapee
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/eskapee \
-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, please refer to the usage documentation and the parameter documentation.
To see the the results of a 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.
nf-core/eskapee was originally written by cjroyer.
We thank the following people for their extensive assistance in the development of this pipeline:
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 #eskapee
channel (you can join with this invite).
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.