Slamseq Docker Image

Introduction

nf-core/slamseq is a bioinformatics analysis pipeline used for https://doi.org/10.1038/nmeth.4435 sequencing data.

The workflow processes SLAMSeq datasets using https://doi.org/10.1186/s***-019-2849-7 and infers https://doi.org/10.1126/science.aao2793 using https://doi.org/10.1186/s***-014-0550-8.

The pipeline is built using [***] a workflow tool to run tasks across multiple compute infrastructures in a very portable manner. It comes with docker containers making installation trivial and results highly reproducible.

Quick Start

i. Install https://nf-co.re/usage/installation

ii. Install either https://docs.docker.com/engine/installation/ or https://www.sylabs.io/guides/3.0/user-guide/ for full pipeline reproducibility (please only use https://conda.io/miniconda.html as a last resort; see https://nf-co.re/usage/configuration#basic-configuration-profiles)

iii. Download the pipeline and test it on a minimal dataset with a single command

bash
nextflow run nf-core/slamseq -profile test,<docker/singularity/conda/institute>

Please check https://github.com/nf-core/configs#documentation to see if a custom config file to run nf-core pipelines already exists for your Institute. If so, you can simply use -profile <institute> in your command. This will enable either docker or singularity and set the appropriate execution settings for your local compute environment.

iv. Start running your own analysis!

bash
nextflow run nf-core/slamseq -profile <docker/singularity/conda/institute> --input design.tsv --genome GRCh38

See usage docs for all of the available options when running the pipeline.

Documentation

The nf-core/slamseq pipeline comes with documentation about the pipeline, found in the docs/ directory:

1. https://nf-co.re/usage/installation
2. Pipeline configuration
   • https://nf-co.re/usage/local_installation
   • https://nf-co.re/usage/adding_own_config
   • https://nf-co.re/usage/reference_genomes
3. Running the pipeline
4. Output and how to interpret the results
5. https://nf-co.re/usage/troubleshooting

Credits

nf-core/slamseq was originally written by Tobias Neumann (https://github.com/t-neumann) for the use at the IMP Vienna.

Many thanks to other who have helped out along the way too, including (but not limited to): https://github.com/apeltzer, https://github.com/drpatelh, https://github.com/pditommaso, https://github.com/MaxUlysse, https://github.com/ewels, https://github.com/Zethson, https://github.com/bgruening, https://github.com/micans.

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 Slack (you can join with https://nf-co.re/join/slack).

Citation

If you use nf-core/slamseq for your analysis, please cite it using the following doi: https://doi.org/10.5281/zenodo.3826585

You can cite slamdunk as follows:

Quantification of experimentally induced nucleotide conversions in high-throughput sequencing datasets.

Tobias Neumann, Veronika A. Herzog, Matthias Muhar, Arndt von Haeseler, Johannes Zuber, Stefan L. Ameres & Philipp Rescheneder.

BMC Bioinformatics 2019 May 20. doi: https://doi.org/10.1186/s***-019-2849-7.

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: https://dx.doi.org/10.1038/s41587-020-0439-x.
ReadCube: Full Access Link

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