Science Score: 44.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
  • Academic publication links
  • Academic email domains
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (10.5%) to scientific vocabulary
Last synced: 6 months ago · JSON representation ·

Repository

Basic Info
  • Host: GitHub
  • Owner: CDCgov
  • License: mit
  • Language: Nextflow
  • Default Branch: main
  • Size: 5.23 MB
Statistics
  • Stars: 0
  • Watchers: 4
  • Forks: 4
  • Open Issues: 1
  • Releases: 1
Created almost 2 years ago · Last pushed 8 months ago
Metadata Files
Readme Changelog Contributing License Code of conduct Citation

README.md

CryptoNet: Cryptosporidium Whole Genome Sequence Nextflow Pipeline - CryptoSSU

Version: 1.0.0

Organization: NCEZID - Division of Foodborne, Waterborne, and Environmental Diseases (DFWED)

Contact Email: ncezid_shareit@cdc.gov

Description: CryptoSSU is a Nextflow DSL2 pipeline designed for molecular detection and species/subtype identification of Cryptosporidium from whole genome (isolate) or metagenomic sequencing. Built for the CDC’s CryptoNet program, the pipeline leverages containerization (Docker/Singularity) to ensure easy deployment, reproducibility, and modular maintenance across Unix-based computing environments.

Exemption: Non-exempt

Keywords: pathogen surveillance, next generation sequencing, bioinformatics, genomics, metagenomics, parasitic disease, Cryptosporidiosis


⚠️ Note: The results produced by this pipeline are not ISO or CLIA-certified and should not be considered diagnostic.


Overview

CryptoSSU is a Nextflow DSL2 pipeline designed for molecular detection and species/subtype identification of Cryptosporidium from whole genome (isolate) or metagenomic sequencing. Built for the CDC’s CryptoNet program, the pipeline leverages containerization (Docker/Singularity) to ensure easy deployment, reproducibility, and modular maintenance across Unix-based computing environments.


Pipeline Features

The pipeline identifies Cryptosporidium species using a BLAST-based 18S approach and gp60 subtyping. Key processing steps include:

  1. Read Quality Control
    Tool: FastQC

  2. Adapter Trimming
    Tool: fastp

  3. Host/Prokaryotic Read Removal (optional)
    Tool: Kraken 2

  4. De novo Assembly
    Tools (choice of one):

  5. Species Detection

Tool: Blast based approach using 18S sequence

  1. GP60 Subtype Characterization

Tool: Blast based approach using GP60 subtype sequences

  1. MultiQC Report

Tool: HTML or text document that summarizes the pipeline results into a report document


Usage

To run the pipeline:

```bash nextflow run CDCgov/WDPBCryptoSSU -r main \ -profile singularity \ -c \ --outdir \ --platform illumina \ --alleleseq assets/allalleles_0.fasta \ --input

```

General disclaimer This repository was created for use by CDC programs to collaborate on public health related projects in support of the CDC mission. GitHub is not hosted by the CDC, but is a third party website used by CDC and its partners to share information and collaborate on software. CDC use of GitHub does not imply an endorsement of any one particular service, product, or enterprise.

Public Domain Standard Notice

This repository constitutes a work of the United States Government and is not subject to domestic copyright protection under 17 USC § 105. This repository is in the public domain within the United States, and copyright and related rights in the work worldwide are waived through the CC0 1.0 Universal public domain dedication. All contributions to this repository will be released under the CC0 dedication. By submitting a pull request you are agreeing to comply with this waiver of copyright interest.

License Standard Notice

The repository utilizes code licensed under the terms of the Apache Software License and therefore is licensed under ASL v2 or later.

This source code in this repository is free: you can redistribute it and/or modify it under the terms of the Apache Software License version 2, or (at your option) any later version.

This source code in this repository is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the Apache Software License for more details.

You should have received a copy of the Apache Software License along with this program. If not, see http://www.apache.org/licenses/LICENSE-2.0.html

The source code forked from other open source projects will inherit its license.

Privacy Standard Notice

This repository contains only non-sensitive, publicly available data and information. All material and community participation is covered by the Disclaimer and Code of Conduct. For more information about CDC's privacy policy, please visit http://www.cdc.gov/other/privacy.html.

Contributing Standard Notice

Anyone is encouraged to contribute to the repository by forking and submitting a pull request. (If you are new to GitHub, you might start with a basic tutorial.) By contributing to this project, you grant a world-wide, royalty-free, perpetual, irrevocable, non-exclusive, transferable license to all users under the terms of the Apache Software License v2 or later.

All comments, messages, pull requests, and other submissions received through CDC including this GitHub page may be subject to applicable federal law, including but not limited to the Federal Records Act, and may be archived. Learn more at http://www.cdc.gov/other/privacy.html.

Records Management Standard Notice

This repository is not a source of government records, but is a copy to increase collaboration and collaborative potential. All government records will be published through the CDC web site.

Additional Standard Notices

Please refer to CDC's Template Repository for more information about contributing to this repository, public domain notices and disclaimers, and code of conduct.

Owner

  • Name: Centers for Disease Control and Prevention
  • Login: CDCgov
  • Kind: organization
  • Email: data@cdc.gov
  • Location: Atlanta, GA

CDC's collaborative software projects to protect America from health, safety, and security threats, both foreign and in the U.S.

Citation (CITATIONS.md)

# cryptosphl/cryptossusphl: Citations

## [nf-core](https://pubmed.ncbi.nlm.nih.gov/32055031/)

> Ewels PA, Peltzer A, Fillinger S, Patel H, Alneberg J, Wilm A, Garcia MU, Di Tommaso P, Nahnsen S. The nf-core framework for community-curated bioinformatics pipelines. Nat Biotechnol. 2020 Mar;38(3):276-278. doi: 10.1038/s41587-020-0439-x. PubMed PMID: 32055031.

## [Nextflow](https://pubmed.ncbi.nlm.nih.gov/28398311/)

> Di Tommaso P, Chatzou M, Floden EW, Barja PP, Palumbo E, Notredame C. Nextflow enables reproducible computational workflows. Nat Biotechnol. 2017 Apr 11;35(4):316-319. doi: 10.1038/nbt.3820. PubMed PMID: 28398311.

## Pipeline tools

- [FastQC](https://www.bioinformatics.babraham.ac.uk/projects/fastqc/)

  > Andrews, S. (2010). FastQC: A Quality Control Tool for High Throughput Sequence Data [Online].

- [MultiQC](https://pubmed.ncbi.nlm.nih.gov/27312411/)

  > Ewels P, Magnusson M, Lundin S, Käller M. MultiQC: summarize analysis results for multiple tools and samples in a single report. Bioinformatics. 2016 Oct 1;32(19):3047-8. doi: 10.1093/bioinformatics/btw354. Epub 2016 Jun 16. PubMed PMID: 27312411; PubMed Central PMCID: PMC5039924.

## Software packaging/containerisation tools

- [Anaconda](https://anaconda.com)

  > Anaconda Software Distribution. Computer software. Vers. 2-2.4.0. Anaconda, Nov. 2016. Web.

- [Bioconda](https://pubmed.ncbi.nlm.nih.gov/29967506/)

  > Grüning B, Dale R, Sjödin A, Chapman BA, Rowe J, Tomkins-Tinch CH, Valieris R, Köster J; Bioconda Team. Bioconda: sustainable and comprehensive software distribution for the life sciences. Nat Methods. 2018 Jul;15(7):475-476. doi: 10.1038/s41592-018-0046-7. PubMed PMID: 29967506.

- [BioContainers](https://pubmed.ncbi.nlm.nih.gov/28379341/)

  > da Veiga Leprevost F, Grüning B, Aflitos SA, Röst HL, Uszkoreit J, Barsnes H, Vaudel M, Moreno P, Gatto L, Weber J, Bai M, Jimenez RC, Sachsenberg T, Pfeuffer J, Alvarez RV, Griss J, Nesvizhskii AI, Perez-Riverol Y. BioContainers: an open-source and community-driven framework for software standardization. Bioinformatics. 2017 Aug 15;33(16):2580-2582. doi: 10.1093/bioinformatics/btx192. PubMed PMID: 28379341; PubMed Central PMCID: PMC5870671.

- [Docker](https://dl.acm.org/doi/10.5555/2600239.2600241)

  > Merkel, D. (2014). Docker: lightweight linux containers for consistent development and deployment. Linux Journal, 2014(239), 2. doi: 10.5555/2600239.2600241.

- [Singularity](https://pubmed.ncbi.nlm.nih.gov/28494014/)

  > Kurtzer GM, Sochat V, Bauer MW. Singularity: Scientific containers for mobility of compute. PLoS One. 2017 May 11;12(5):e0177459. doi: 10.1371/journal.pone.0177459. eCollection 2017. PubMed PMID: 28494014; PubMed Central PMCID: PMC5426675.

GitHub Events

Total
  • Release event: 1
  • Delete event: 1
  • Issue comment event: 1
  • Push event: 84
  • Pull request review event: 4
  • Pull request event: 14
  • Fork event: 4
  • Create event: 3
Last Year
  • Release event: 1
  • Delete event: 1
  • Issue comment event: 1
  • Push event: 84
  • Pull request review event: 4
  • Pull request event: 14
  • Fork event: 4
  • Create event: 3

Dependencies

modules/nf-core/blast/blastn/meta.yml cpan
modules/nf-core/blast/makeblastdb/meta.yml cpan
modules/nf-core/custom/dumpsoftwareversions/meta.yml cpan
modules/nf-core/fastp/meta.yml cpan
modules/nf-core/fastqc/meta.yml cpan
modules/nf-core/kraken2/build/meta.yml cpan
modules/nf-core/kraken2/kraken2/meta.yml cpan
modules/nf-core/multiqc/meta.yml cpan
modules/nf-core/quast/meta.yml cpan
modules/nf-core/unicycler/meta.yml cpan
modules/nf-core/untar/meta.yml cpan
pyproject.toml pypi
modules/nf-core/blast/blastn/environment.yml conda
  • blast 2.15.0.*
modules/nf-core/blast/makeblastdb/environment.yml conda
  • blast 2.15.0.*
modules/nf-core/custom/dumpsoftwareversions/environment.yml conda
  • multiqc 1.19.*
modules/nf-core/fastp/environment.yml conda
  • fastp 0.23.4.*
modules/nf-core/fastqc/environment.yml conda
  • fastqc 0.12.1.*
modules/nf-core/kraken2/build/environment.yml conda
  • coreutils 9.4.*
  • kraken2 2.1.3.*
  • pigz 2.8.*
modules/nf-core/kraken2/kraken2/environment.yml conda
  • coreutils 9.4.*
  • kraken2 2.1.3.*
  • pigz 2.8.*
modules/nf-core/multiqc/environment.yml conda
  • multiqc 1.19.*
modules/nf-core/quast/environment.yml conda
  • quast 5.2.0.*
modules/nf-core/unicycler/environment.yml conda
  • unicycler 0.5.0.*
modules/nf-core/untar/environment.yml conda
  • grep 3.11.*
  • sed 4.8.*
  • tar 1.34.*