Skip to content

Latest commit

 

History

History
108 lines (75 loc) · 6.04 KB

README.md

File metadata and controls

108 lines (75 loc) · 6.04 KB
Raw

Cite with Zenodo

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

Introduction

sanger-tol/ascc is a bioinformatics pipeline that is meant for detecting cobionts and contaminants in genome assemblies. ASCC stands for Assembly Screen for Cobionts and Contaminants. The pipeline aggregates tools such as BLAST, GC and coverage calculation, FCS-adaptor, FCS-GX, VecScreen, BlobToolKit, the BlobToolKit pipeline, Tiara, Kraken, Diamond BLASTX, and kmer counting and with kcounter+scipy. The main outputs are:

  • A CSV table with taxonomic classifications of the sequences from the consitutent tools.
  • A BlobToolKit dataset that can contain variables that are not present in BlobToolKit datasets produced by the BlobToolKit pipeline (https://github.com/sanger-tol/blobtoolkit) on its own. For example, ASCC can incorporate FCS-GX results into a BlobToolKit dataset.
  • Individual report files for adapter, PacBio barcode and organellar contaminants. The only required input file for ASCC is the assembly FASTA file. Optional inputs are sequencing reads and organellar FASTA files. All individual components of the pipeline are optional, so it is possible to do lightweight runs with assemblies that have a simple composition of species and comprehensive runs with assemblies with complex composition.

sanger-tol/ascc overview diagram

  1. Run a selection of processes from the list below (pick any that you think will be useful).
  • FCS-GX
  • FCS-adaptor
  • VecScreen
  • Tiara
  • BlobToolKit Pipeline
  • nt BLAST
  • nr and Uniprot Diamond BLASTX
  • GC and coverage calculation
  • PacBio barcodes screen
  • Organellar BLAST
  • nt Kraken2
  • kmer counting + dimensionality reduction
  1. Postprocess the results of the previous step to produce summary files. What processes were run in the previous step determines what summary files can be generated. The possible outputs are:
  • CSV table of sequence classification results
  • BlobToolKit dataset
  • CSV table of average coverage per phylum
  • Adapter and organellar contamination report files

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 sanger-tol/ascc \
   -profile <docker/singularity/.../institute> \
   --input YAML \
   --outdir <OUTDIR> -entry SANGERTOL_ASCC --include ALL

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/ascc was written by Eerik Aunin, Damon Lee Pointon, James Torrance, Ying Sims and Will Eagles. Pipeline development was supervised by Shane A. McCarthy and Matthieu Muffato.

We thank Michael Paulini, Camilla Santos, Noah Gettle and Ksenia Krasheninnikova for testing the pipeline.

Contributions and Support

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

Citations

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

This pipeline uses code and infrastructure developed and maintained by the nf-core community, reused here under the MIT license.

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.