1
0
Fork 0
mirror of https://github.com/MillironX/taxprofiler.git synced 2024-12-22 04:08:18 +00:00
Highly parallelised multi-taxonomic profiling of shotgun metagenomic data
Find a file
2023-04-28 14:26:38 +00:00
.devcontainer Template update for nf-core/tools version 2.7.1 2022-12-08 13:18:23 +00:00
.github Template update for nf-core/tools version 2.8 2023-04-28 14:26:38 +00:00
assets Template update for nf-core/tools version 2.8 2023-04-28 14:26:38 +00:00
bin Template update for nf-core/tools version 2.8 2023-04-28 14:26:38 +00:00
conf Template update for nf-core/tools version 2.8 2023-04-28 14:26:38 +00:00
docs Template update for nf-core/tools version 2.8 2023-04-28 14:26:38 +00:00
lib Template update for nf-core/tools version 2.8 2023-04-28 14:26:38 +00:00
modules Template update for nf-core/tools version 2.8 2023-04-28 14:26:38 +00:00
subworkflows/local Template update for nf-core/tools version 2.3 2022-03-15 21:05:37 +00:00
workflows Template update for nf-core/tools version 2.7.2 2022-12-19 12:10:58 +00:00
.editorconfig Template update for nf-core/tools version 2.8 2023-04-28 14:26:38 +00:00
.gitattributes Template update for nf-core/tools version 2.7.1 2022-12-08 13:18:23 +00:00
.gitignore initial template build from nf-core/tools, version 2.2 2022-02-18 07:55:14 +01:00
.gitpod.yml Template update for nf-core/tools version 2.3.2 2022-03-24 11:48:43 +00:00
.nf-core.yml Template update for nf-core/tools version 2.3 2022-03-15 21:05:37 +00:00
.pre-commit-config.yaml Template update for nf-core/tools version 2.8 2023-04-28 14:26:38 +00:00
.prettierignore Template update for nf-core/tools version 2.7.1 2022-12-08 13:18:23 +00:00
.prettierrc.yml Template update for nf-core/tools version 2.3.1 2022-03-23 13:57:56 +00:00
CHANGELOG.md Template update for nf-core/tools version 2.8 2023-04-28 14:26:38 +00:00
CITATIONS.md Template update for nf-core/tools version 2.3.1 2022-03-23 13:57:56 +00:00
CODE_OF_CONDUCT.md initial template build from nf-core/tools, version 2.2 2022-02-18 07:55:14 +01:00
LICENSE Template update for nf-core/tools version 2.8 2023-04-28 14:26:38 +00:00
main.nf Template update for nf-core/tools version 2.8 2023-04-28 14:26:38 +00:00
modules.json Template update for nf-core/tools version 2.8 2023-04-28 14:26:38 +00:00
nextflow.config Template update for nf-core/tools version 2.8 2023-04-28 14:26:38 +00:00
nextflow_schema.json Template update for nf-core/tools version 2.8 2023-04-28 14:26:38 +00:00
pyproject.toml Template update for nf-core/tools version 2.5.1 2022-09-01 13:34:04 +00:00
README.md Template update for nf-core/tools version 2.8 2023-04-28 14:26:38 +00:00
tower.yml Template update for nf-core/tools version 2.8 2023-04-28 14:26:38 +00:00

nf-core/taxprofiler nf-core/taxprofiler

AWS CICite with Zenodo

Nextflow run with conda run with docker run with singularity Launch on Nextflow Tower

Get help on SlackFollow on TwitterFollow on MastodonWatch on YouTube

Introduction

nf-core/taxprofiler is a bioinformatics pipeline that ...

  1. Read QC (FastQC)
  2. Present QC for raw reads (MultiQC)

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/taxprofiler \
   -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.

Pipeline output

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.

Credits

nf-core/taxprofiler was originally written by James A. Fellows Yates, Sofia Stamouli, Moritz E. Beber, and the nf-core/taxprofiler team.

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