blobtoolkit
Nextflow DSL2 pipeline to generate data for a BlobToolKit analysis. This workflow is part of the Tree of Life production suite.
Science Score: 75.0%
This score indicates how likely this project is to be science-related based on various indicators:
-
✓CITATION.cff file
Found CITATION.cff file -
✓codemeta.json file
Found codemeta.json file -
✓.zenodo.json file
Found .zenodo.json file -
✓DOI references
Found 10 DOI reference(s) in README -
✓Academic publication links
Links to: ncbi.nlm.nih.gov -
○Academic email domains
-
✓Institutional organization owner
Organization sanger-tol has institutional domain (www.sanger.ac.uk) -
○JOSS paper metadata
-
○Scientific vocabulary similarity
Low similarity (9.9%) to scientific vocabulary
Keywords
Repository
Nextflow DSL2 pipeline to generate data for a BlobToolKit analysis. This workflow is part of the Tree of Life production suite.
Basic Info
- Host: GitHub
- Owner: sanger-tol
- License: mit
- Language: Nextflow
- Default Branch: main
- Homepage: https://pipelines.tol.sanger.ac.uk/blobtoolkit
- Size: 78.1 MB
Statistics
- Stars: 13
- Watchers: 6
- Forks: 6
- Open Issues: 13
- Releases: 10
Topics
Metadata Files
README.md
Introduction
sanger-tol/blobtoolkit is a bioinformatics pipeline that can be used to identify and analyse non-target DNA for eukaryotic genomes. It takes a samplesheet of BAM/CRAM/FASTQ/FASTA files as input, calculates genome statistics, coverage and completeness information, combines them in a TSV file by window size to create a BlobDir dataset and static plots.
- Calculate genome statistics in windows (
fastawindows) - Calculate Coverage (
blobtk/depth) - Determine the appropriate BUSCO lineages from the taxonomy.
- Run BUSCO (
busco) - Extract BUSCO genes (
blobtoolkit/extractbuscos) - Run Diamond BLASTp against extracted BUSCO genes (
diamond/blastp) - Run BLASTx against sequences with no hit (
diamond/blastx) - Run BLASTn against sequences still with not hit (
blast/blastn) - Count BUSCO genes (
blobtoolkit/countbuscos) - Generate combined sequence stats across various window sizes (
blobtoolkit/windowstats) - Imports analysis results into a BlobDir dataset (
blobtoolkit/blobdir) - Create static plot images (
blobtk/images)
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 testbefore running the workflow on actual data.
First, prepare a samplesheet with your input data that looks as follows:
samplesheet.csv:
csv
sample,datatype,datafile,library_layout
mMelMel3,hic,GCA_922984935.2.hic.mMelMel3.cram,PAIRED
mMelMel1,illumina,GCA_922984935.2.illumina.mMelMel1.cram,PAIRED
mMelMel3,ont,GCA_922984935.2.ont.mMelMel3.cram,SINGLE
Each row represents an aligned file.
Rows with the same sample identifier are considered technical replicates.
The datatype refers to the sequencing technology used to generate the underlying raw data and follows a controlled vocabulary (ont, hic, pacbio, pacbio_clr, illumina).
The library layout indicates whether the reads are paired or single.
The aligned read files can be generated using the sanger-tol/readmapping pipeline.
Now, you can run the pipeline using:
bash
nextflow run sanger-tol/blobtoolkit \
-profile <docker/singularity/.../institute> \
--input samplesheet.csv \
--outdir <OUTDIR> \
--fasta genome.fasta \
--accession GCA_XXXXXXXXX.X \
--taxon XXXX \
--taxdump /path/to/taxdump/database \
--blastp /path/to/diamond/database \
--blastn /path/to/blastn/database \
--blastx /path/to/blastx/database
[!WARNING] Please provide pipeline parameters via the CLI or Nextflow
-params-fileoption. Custom config files including those provided by the-cNextflow 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
For more details about the output files and reports, please refer to the output documentation.
Credits
sanger-tol/blobtoolkit was written in Nextflow by Alexander Ramos Diaz, Zaynab Butt, Matthieu Muffato, and Priyanka Surana. The orignal design and coding for BlobToolKit software and Snakemake pipeline was done by Richard Challis and Sujai Kumar.
We thank the following people for their assistance in the development of this pipeline:
Contributions and Support
If you would like to contribute to this pipeline, please see the contributing guidelines.
Citations
If you use sanger-tol/blobtoolkit for your analysis, please cite it using the following doi: 10.5281/zenodo.7949058
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.
Owner
- Name: Tree of Life programme
- Login: sanger-tol
- Kind: organization
- Location: United Kingdom
- Website: https://www.sanger.ac.uk/programme/tree-of-life/
- Twitter: sangertol
- Repositories: 15
- Profile: https://github.com/sanger-tol
The Tree of Life Programme investigates the diversity of complex organisms (eukaryotes) through sequencing and cellular technology
Citation (CITATION.cff)
authors:
- affiliation: Wellcome Sanger Institute
family-names: Butt
given-names: Zaynab
orcid: https://orcid.org/0009-0009-7934-8440
website: https://github.com/zb32
- affiliation: Wellcome Sanger Institute
email: tc25@sanger.ac.uk
family-names: Chafin
given-names: Tyler
orcid: https://orcid.org/0000-0001-8687-5905
website: https://github.com/tkchafin
- affiliation: Wellcome Sanger Institute
family-names: Challis
given-names: Rich
orcid: https://orcid.org/0000-0002-3502-1122
website: https://github.com/rjchallis
- affiliation: Wellcome Sanger Institute
email: sujaikumar@gmail.com
family-names: Kumar
given-names: Sujai
orcid: https://orcid.org/0000-0001-5902-6641
website: https://github.com/sujaikumar
- affiliation: Wellcome Sanger Institute
email: mm49@sanger.ac.uk
family-names: Muffato
given-names: Matthieu
orcid: https://orcid.org/0000-0002-7860-3560
website: https://github.com/muffato
- affiliation: Wellcome Sanger Institute
email: 729395+gq1@users.noreply.github.com
family-names: Qi
given-names: Guoying
orcid: https://orcid.org/0000-0003-1262-8973
website: https://github.com/gq1
- email: ra.ramos.diaz@gmail.com
family-names: "Ramos D\xEDaz"
given-names: Alexander
orcid: https://orcid.org/0000-0001-6410-3349
website: https://github.com/alxndrdiaz
- affiliation: Wellcome Sanger Institute
email: yy5@sanger.ac.uk
family-names: Sims
given-names: Yumi
orcid: https://orcid.org/0000-0003-4765-4872
website: https://github.com/yumisims
- affiliation: Wellcome Sanger Institute
email: ps22@sanger.ac.uk
family-names: Surana
given-names: Priyanka
orcid: https://orcid.org/0000-0002-7167-0875
website: https://github.com/priyanka-surana
- affiliation: Wellcome Sanger Institute
email: 113996036+BethYates@users.noreply.github.com
family-names: Yates
given-names: Bethan
orcid: https://orcid.org/0000-0003-1658-1762
website: https://github.com/BethYates
cff-version: 1.2.0
date-released: "2025-04-25"
doi: 10.5281/zenodo.7949058
license: MIT
message: If you use this software, please cite it using the metadata from this file
and all references from CITATIONS.md .
repository-code: https://github.com/sanger-tol/blobtoolkit
title: sanger-tol/blobtoolkit v0.8.0 -
type: software
url: https://pipelines.tol.sanger.ac.uk/blobtoolkit
version: 0.8.0
GitHub Events
Total
- Create event: 34
- Release event: 1
- Issues event: 49
- Watch event: 2
- Delete event: 34
- Member event: 1
- Issue comment event: 167
- Push event: 122
- Pull request review comment event: 12
- Pull request event: 71
- Pull request review event: 41
- Fork event: 4
Last Year
- Create event: 34
- Release event: 1
- Issues event: 49
- Watch event: 2
- Delete event: 34
- Member event: 1
- Issue comment event: 167
- Push event: 122
- Pull request review comment event: 12
- Pull request event: 71
- Pull request review event: 41
- Fork event: 4
Issues and Pull Requests
Last synced: 6 months ago
All Time
- Total issues: 25
- Total pull requests: 33
- Average time to close issues: 2 months
- Average time to close pull requests: 11 days
- Total issue authors: 11
- Total pull request authors: 7
- Average comments per issue: 1.96
- Average comments per pull request: 1.67
- Merged pull requests: 18
- Bot issues: 0
- Bot pull requests: 0
Past Year
- Issues: 23
- Pull requests: 33
- Average time to close issues: about 1 month
- Average time to close pull requests: 11 days
- Issue authors: 11
- Pull request authors: 7
- Average comments per issue: 2.04
- Average comments per pull request: 1.67
- Merged pull requests: 18
- Bot issues: 0
- Bot pull requests: 0
Top Authors
Issue Authors
- muffato (16)
- gitcruz (4)
- foreignsand (3)
- BethYates (2)
- DLBPointon (2)
- AlcaArctica (1)
- abdo3a (1)
- r-mashoodh (1)
- yumisims (1)
- gq1 (1)
- tkchafin (1)
- MartinPippel (1)
- JudithR (1)
- annabel-NZ (1)
- priyanka-surana (1)
Pull Request Authors
- muffato (28)
- tkchafin (9)
- gq1 (7)
- sanger-tolsoft (5)
- yumisims (4)
- DLBPointon (4)
- BethYates (1)
- Quanmat (1)
Top Labels
Issue Labels
Pull Request Labels
Dependencies
- mshick/add-pr-comment v1 composite
- actions/checkout v2 composite
- actions/checkout v3 composite
- actions/setup-node v2 composite
- actions/checkout v2 composite
- actions/setup-node v2 composite
- actions/setup-python v3 composite
- actions/upload-artifact v2 composite
- mshick/add-pr-comment v1 composite
- nf-core/setup-nextflow v1 composite
- psf/black stable composite
- dawidd6/action-download-artifact v2 composite
- marocchino/sticky-pull-request-comment v2 composite
- nf-core/tower-action v2 composite
- nf-core/tower-action v2 composite
