sequencecomposition

Nextflow DSL2 pipeline to extract statistics from a genome about its sequence composition

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

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 (12.0%) to scientific vocabulary

Keywords

genomics kmer-frequency-count nextflow pipeline running-average shannon-entropy
Last synced: 6 months ago · JSON representation ·

Repository

Nextflow DSL2 pipeline to extract statistics from a genome about its sequence composition

Basic Info
Statistics
  • Stars: 2
  • Watchers: 6
  • Forks: 2
  • Open Issues: 20
  • Releases: 2
Topics
genomics kmer-frequency-count nextflow pipeline running-average shannon-entropy
Created over 3 years ago · Last pushed 8 months ago
Metadata Files
Readme Changelog Contributing License Code of conduct Citation

README.md

sanger-tol/sequencecomposition

GitHub Actions CI Status GitHub Actions Linting 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/sequencecomposition is a bioinformatics analysis pipeline that extracts statistics from a genome about its sequence composition.

The pipeline takes an assembly Fasta file (possibly compressed), runs fasta_windows on it, and transforms the outputs into files more practical for downstream use.

Steps involved:

  • Run fasta_windows on the assembly Fasta file.
  • Extract single-statistics bedGraph files from the multi-statistics TSV files fasta_windows outputs.
  • Compress and index all bedGraph and TSV files 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 path of the Fasta file to analyse like this:

console nextflow run sanger-tol/sequencecomposition --fasta /path/to/genome.fa

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/sequencecomposition was originally written by Matthieu Muffato.

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/sequencecomposition for your analysis, please cite it using the following doi: 10.5281/zenodo.14358108

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/sequencecomposition
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.14358108
repository-code: "https://github.com/sanger-tol/sequencecomposition"
license: MIT
commit: TODO
version: 2.0.0
date-released: "2022-10-08"

GitHub Events

Total
  • Create event: 7
  • Release event: 1
  • Issues event: 2
  • Delete event: 8
  • Member event: 1
  • Issue comment event: 18
  • Push event: 27
  • Pull request review event: 7
  • Pull request event: 14
  • Fork event: 2
Last Year
  • Create event: 7
  • Release event: 1
  • Issues event: 2
  • Delete event: 8
  • Member event: 1
  • Issue comment event: 18
  • Push event: 27
  • Pull request review event: 7
  • Pull request event: 14
  • Fork event: 2

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
.github/workflows/clean-up.yml actions
  • actions/stale v7 composite
.github/workflows/sanger_test.yml actions
  • actions/upload-artifact v3 composite
  • seqeralabs/action-tower-launch v2 composite
.github/workflows/sanger_test_full.yml actions
  • actions/upload-artifact v3 composite
  • seqeralabs/action-tower-launch v2 composite
modules/nf-core/custom/dumpsoftwareversions/meta.yml cpan
modules/nf-core/custom/getchromsizes/meta.yml cpan
modules/nf-core/fastawindows/meta.yml cpan
modules/nf-core/gunzip/meta.yml cpan
modules/nf-core/tabix/bgzip/meta.yml cpan
modules/nf-core/tabix/tabix/meta.yml cpan
modules/nf-core/custom/dumpsoftwareversions/environment.yml pypi
modules/nf-core/custom/getchromsizes/environment.yml pypi
modules/nf-core/fastawindows/environment.yml pypi
modules/nf-core/gunzip/environment.yml pypi
modules/nf-core/tabix/bgzip/environment.yml pypi
modules/nf-core/tabix/tabix/environment.yml pypi
pyproject.toml pypi