Introduction

sanger-tol/longreadmag is a bioinformatics pipeline for the production of metagenome-assembled genomes.

The pipeline is built using Nextflow, a workflow tool to run tasks across multiple compute infrastructures in a very portable manner. It uses Docker/Singularity containers making installation trivial and results highly reproducible. The Nextflow DSL2 implementation of this pipeline uses one container per process which makes it much easier to maintain and update software dependencies. Where possible, these processes have been submitted to and installed from nf-core/modules in order to make them available to all nf-core pipelines, and to everyone within the Nextflow community!

  1. Parse input yaml ( YAML_INPUT )

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.

Currently, it is advised to run the pipeline with docker or singularity as a small number of major modules do not currently have a conda env associated with them.

Now, you can run the pipeline using:

# For the FULL pipeline
nextflow run main.nf -profile singularity --input {INPUT_YAML}.yaml --outdir {OUTDIR}

An example longreadmag.yaml can be found here.

Further documentation about the pipeline can be found in the following files: usage, parameters and output.

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.

Credits

sanger-tol/longreadmag has been written by William Eagles (@weaglesBio) and Noah Gettle (@weaglesBio).

Contributions and Support

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

Citations

Tools

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.

Run with

Read how to configure the Seqera Platform CLI here.

clones in last 1 month

66

stars

1

watchers

1

last release

N/A

last updated

3 weeks ago

open issues

0

open pull requests

0

collaborators