insdcdownload

Nextflow DSL2 pipeline to download assemblies from INSDC.

https://github.com/sanger-tol/insdcdownload

Science Score: 65.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
  • Academic email domains
  • Institutional organization owner
    Organization sanger-tol has institutional domain (www.sanger.ac.uk)
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (11.0%) to scientific vocabulary

Keywords

download genomics indexing nextflow pipeline
Last synced: 4 months ago · JSON representation ·

Repository

Nextflow DSL2 pipeline to download assemblies from INSDC.

Basic Info
Statistics
  • Stars: 1
  • Watchers: 6
  • Forks: 3
  • Open Issues: 7
  • Releases: 0
Topics
download genomics indexing nextflow pipeline
Created over 3 years ago · Last pushed 5 months ago
Metadata Files
Readme Changelog Contributing License Code of conduct Citation

README.md

sanger-tol/insdcdownload

GitHub Actions CI Status

Cite with Zenodo

Nextflow run with conda run with docker run with singularity

Get help on Slack Follow on Twitter Watch on YouTube

Introduction

sanger-tol/insdcdownload is a pipeline that downloads assemblies from INSDC into a Tree of Life directory structure.

The pipeline takes an assembly accession number, as well as the assembly name, and downloads it. It also builds a set of common indices (such as samtools faidx), and extracts the repeat-masking performed by the NCBI.

Steps involved:

  • Download from the NCBI the genomic sequence (Fasta) and the assembly stats and reports files.
  • Turn the masked Fasta file into an unmasked one.
  • Compress and index all Fasta files with bgzip, samtools faidx, and samtools dict.
  • Generate the .sizes file usually required for conversion of data files to UCSC's "big" formats, e.g. bigBed.
  • Extract the coordinates of the masked regions into a BED file.
  • Compress and index the BED file with bgzip and tabix.

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.

The easiest is to provide the exact name and accession number of the assembly like this:

console nextflow run sanger-tol/insdcdownload --assembly_accession GCA_927399515.1 --assembly_name gfLaeSulp1.1

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.

The pipeline also supports bulk downloads through a sample-sheet. More information about this mode on our pipeline website.

Credits

sanger-tol/insdcdownload was mainly written by Matthieu Muffato, with major borrowings from a's read-mapping pipeline, e.g. the script to remove the repeat-masking, and the overall structure and layout of the sub-workflows.

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.

For further information or help, don't hesitate to get in touch on the Slack #pipelines channel. Please create an issue on GitHub if you are not on the Sanger slack channel.

Citations

If you use sanger-tol/insdcdownload for your analysis, please cite it using the following doi: 10.5281/zenodo.6983932

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

The Tree of Life Programme investigates the diversity of complex organisms (eukaryotes) through sequencing and cellular technology

Citation (CITATION.cff)

# This CITATION.cff file was generated with cffinit.
# Visit https://bit.ly/cffinit to generate yours today!

cff-version: 1.2.0
title: sanger-tol/insdcdownload
message: >-
    If you use this software, please cite it using the
    metadata from this file.
type: software
authors:
    - given-names: Matthieu
      family-names: Muffato
      affiliation: Wellcome Sanger Institute
      orcid: "https://orcid.org/0000-0002-7860-3560"
    - given-names: Priyanka
      family-names: Surana
      orcid: "https://orcid.org/0000-0002-7167-0875"
      affiliation: Wellcome Sanger Institute
    - given-names: Tyler
      family-names: Chafin
      orcid: "https://orcid.org/0000-0001-8687-5905"
      affiliation: Wellcome Sanger Institute
identifiers:
    - type: doi
      value: 10.5281/zenodo.6983932
repository-code: "https://github.com/sanger-tol/insdcdownload"
license: MIT
commit: TODO
version: 2.0.0
date-released: "2022-10-07"

GitHub Events

Total
  • Create event: 8
  • Issues event: 4
  • Release event: 2
  • Delete event: 5
  • Member event: 1
  • Issue comment event: 15
  • Push event: 15
  • Pull request review event: 7
  • Pull request review comment event: 4
  • Pull request event: 12
Last Year
  • Create event: 8
  • Issues event: 4
  • Release event: 2
  • Delete event: 5
  • Member event: 1
  • Issue comment event: 15
  • Push event: 15
  • Pull request review event: 7
  • Pull request review comment event: 4
  • Pull request event: 12

Issues and Pull Requests

Last synced: 4 months ago

All Time
  • Total issues: 4
  • Total pull requests: 2
  • Average time to close issues: about 2 years
  • Average time to close pull requests: 3 days
  • Total issue authors: 3
  • Total pull request authors: 2
  • Average comments per issue: 0.0
  • Average comments per pull request: 0.5
  • Merged pull requests: 1
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 3
  • Pull requests: 2
  • Average time to close issues: N/A
  • Average time to close pull requests: 3 days
  • Issue authors: 2
  • Pull request authors: 2
  • Average comments per issue: 0.0
  • Average comments per pull request: 0.5
  • Merged pull requests: 1
  • Bot issues: 0
  • Bot pull requests: 0
Top Authors
Issue Authors
  • muffato (5)
  • priyanka-surana (2)
  • sainsachiko (1)
  • BethYates (1)
Pull Request Authors
  • tkchafin (6)
  • gq1 (2)
  • muffato (2)
Top Labels
Issue Labels
enhancement (2) user request (2) bug (2) maintain (1) question (1) feature (1)
Pull Request Labels
enhancement (1)

Dependencies

.github/workflows/branch.yml actions
  • mshick/add-pr-comment v1 composite
.github/workflows/ci.yml actions
  • actions/checkout v2 composite
  • nf-core/setup-nextflow v1 composite
.github/workflows/fix-linting.yml actions
  • actions/checkout v3 composite
  • actions/setup-node v2 composite
.github/workflows/linting.yml actions
  • 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
.github/workflows/linting_comment.yml actions
  • dawidd6/action-download-artifact v2 composite
  • marocchino/sticky-pull-request-comment v2 composite
modules/nf-core/modules/custom/dumpsoftwareversions/meta.yml cpan
modules/nf-core/modules/custom/getchromsizes/meta.yml cpan
modules/nf-core/modules/samtools/dict/meta.yml cpan
modules/nf-core/modules/samtools/faidx/meta.yml cpan
modules/nf-core/modules/tabix/bgzip/meta.yml cpan
modules/nf-core/modules/tabix/tabix/meta.yml cpan