whale

WHALE: (W)orkflow for (H)uman-genome (A)nalysis of (L)ong-read (E)xperiments

https://github.com/rafafariasvarona/whale

Science Score: 13.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
  • DOI references
  • Academic publication links
  • Academic email domains
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (9.1%) to scientific vocabulary
Last synced: 10 months ago · JSON representation

Repository

WHALE: (W)orkflow for (H)uman-genome (A)nalysis of (L)ong-read (E)xperiments

Basic Info
  • Host: GitHub
  • Owner: RafaFariasVarona
  • License: mit
  • Language: Nextflow
  • Default Branch: master
  • Homepage:
  • Size: 59.5 MB
Statistics
  • Stars: 0
  • Watchers: 1
  • Forks: 1
  • Open Issues: 0
  • Releases: 0
Created almost 2 years ago · Last pushed over 1 year ago
Metadata Files
Readme Changelog Contributing License Code of conduct Citation

README.md

WHALE: (W)orkflow for (H)uman-genome (A)nalysis of (L)ong-read (E)xperiments

Introduction

WHALE is a bioinformatics pipeline based on Nextflow and nf-core for long-read DNA sequencing analysis. It is optimized for the study and diagnosis of rare diseases. It takes a samplesheet as input and performs quality control, alignment, variant calling, variant integration and annotation.

Pipeline summary

  1. Read QC (FastQC)
  2. Present QC for raw reads (MultiQC)
  3. Alignment (Minimap2)
  4. Variant calling
  5. Merge variant calling
  6. Annotation

Usage

First, prepare a samplesheet with your input data. Depending on which step of the analysis you want to run, the input data type can be: fastq, bam (and bai), vcf or bed. The samplesheet should look as follows:

samplesheet.csv:

csv sample,fastq A123,/path/to/your/input/file/A123.fastq.gz B456,/path/to/your/input/file/B456.fastq.gz

There are two types of full analysis: - SNV analysis: -profile snvanalysis - SV analysis: -profile svanalysis

Each full analysis can start with: - Alignment: --step mapping (input data type: fastq) (default) - Variant calling: --step variant_calling (input data type: bam and bai)

A specific step of the analysis can be executed: - SNV calling (and merge): -profile snvcalling (input data type: bam and bai) - SV calling (and merge): -profile svcalling (input data type: bam and bai) - SNV annotation: -profile snvannotation (input data type: vcf) - SV annotation: -profile svannotation (input data type: bed)

Profiles to use in the CCC (UAM): - -profile uam,singularity,batch - -profile uam_allcontigs,singularity,batch

Profiles to use in the server: - -profile tblabserver,singularity - -profile tblabserver_allcontigs,singularity

Examples

SNV and SV analysis starting with variant calling in the server:

bash nextflow run WHALE \ -profile snv_analysis,sv_analysis,tblabserver,singularity \ --input samplesheet.csv \ --outdir <OUTDIR> \ --step variant_calling

SV calling in the CCC:

bash nextflow run WHALE \ -profile sv_calling,uam,singularity,batch \ --input samplesheet.csv \ --outdir <OUTDIR>

Pipeline output

WHALE will create the following subdirectories in the output directory: - alignment - snvcalling - snvmerge - snvannotation - svcalling - svmerge - svannotation - overlappingsvsamples - multiqc - pipeline_info

Citations

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

Illustration by Yolanda Bentez

Owner

  • Login: RafaFariasVarona
  • Kind: user

GitHub Events

Total
  • Push event: 25
  • Pull request event: 2
Last Year
  • Push event: 25
  • Pull request event: 2

Dependencies

.github/workflows/awsfulltest.yml actions
  • actions/upload-artifact v4 composite
  • seqeralabs/action-tower-launch v2 composite
.github/workflows/awstest.yml actions
  • actions/upload-artifact v4 composite
  • seqeralabs/action-tower-launch v2 composite
.github/workflows/branch.yml actions
  • mshick/add-pr-comment b8f338c590a895d50bcbfa6c5859251edc8952fc composite
.github/workflows/ci.yml actions
  • actions/checkout 0ad4b8fadaa221de15dcec353f45205ec38ea70b composite
  • jlumbroso/free-disk-space 54081f138730dfa15788a46383842cd2f914a1be composite
  • nf-core/setup-nextflow v2 composite
.github/workflows/clean-up.yml actions
  • actions/stale 28ca1036281a5e5922ead5184a1bbf96e5fc984e composite
.github/workflows/download_pipeline.yml actions
  • actions/setup-python 82c7e631bb3cdc910f68e0081d67478d79c6982d composite
  • eWaterCycle/setup-singularity 931d4e31109e875b13309ae1d07c70ca8fbc8537 composite
  • jlumbroso/free-disk-space 54081f138730dfa15788a46383842cd2f914a1be composite
  • nf-core/setup-nextflow v2 composite
.github/workflows/fix-linting.yml actions
  • actions/checkout 0ad4b8fadaa221de15dcec353f45205ec38ea70b composite
  • actions/setup-python 82c7e631bb3cdc910f68e0081d67478d79c6982d composite
  • peter-evans/create-or-update-comment 71345be0265236311c031f5c7866368bd1eff043 composite
.github/workflows/linting.yml actions
  • actions/checkout 0ad4b8fadaa221de15dcec353f45205ec38ea70b composite
  • actions/setup-python 82c7e631bb3cdc910f68e0081d67478d79c6982d composite
  • actions/upload-artifact 65462800fd760344b1a7b4382951275a0abb4808 composite
  • nf-core/setup-nextflow v2 composite
.github/workflows/linting_comment.yml actions
  • dawidd6/action-download-artifact 09f2f74827fd3a8607589e5ad7f9398816f540fe composite
  • marocchino/sticky-pull-request-comment 331f8f5b4215f0445d3c07b4967662a32a2d3e31 composite
.github/workflows/release-announcements.yml actions
  • actions/setup-python 82c7e631bb3cdc910f68e0081d67478d79c6982d composite
  • rzr/fediverse-action master composite
  • zentered/bluesky-post-action 80dbe0a7697de18c15ad22f4619919ceb5ccf597 composite
modules/local/automap/meta.yml cpan
modules/local/bnd_merge/meta.yml cpan
modules/local/clair3/meta.yml cpan
modules/local/consensus_gt/meta.yml cpan
modules/local/del_merge/meta.yml cpan
modules/local/dup_merge/meta.yml cpan
modules/local/filter/pass/meta.yml cpan
modules/local/filter/qual/meta.yml cpan
modules/local/format2info/meta.yml cpan
modules/local/format_vcf/meta.yml cpan
modules/local/get_vcf_fields/meta.yml cpan
modules/local/header_variants_vcf/meta.yml cpan
modules/local/ins_merge/meta.yml cpan
modules/local/inv_merge/meta.yml cpan
modules/local/mergetsv/meta.yml cpan
modules/local/nanocaller/meta.yml cpan
modules/local/postmerge/meta.yml cpan
modules/local/postvep/meta.yml cpan
modules/local/premerge/meta.yml cpan
modules/local/sample_info/meta.yml cpan
modules/local/software_info/meta.yml cpan
modules/local/splitvcfpvm/meta.yml cpan
modules/local/sv_samples/meta.yml cpan
modules/local/svim/meta.yml cpan
modules/local/vcftobed1/meta.yml cpan
modules/local/vcftobed2/meta.yml cpan
modules/nf-core/annotsv/annotsv/meta.yml cpan
modules/nf-core/annotsv/installannotations/meta.yml cpan
modules/nf-core/bcftools/merge/meta.yml cpan
modules/nf-core/bcftools/norm/meta.yml cpan
modules/nf-core/bcftools/query/meta.yml cpan
modules/nf-core/bcftools/sort/meta.yml cpan
modules/nf-core/bcftools/view/meta.yml cpan
modules/nf-core/cutesv/meta.yml cpan
modules/nf-core/deepvariant/meta.yml cpan
modules/nf-core/ensemblvep/vep/meta.yml cpan
modules/nf-core/fastqc/meta.yml cpan
modules/nf-core/minimap2/align/meta.yml cpan
modules/nf-core/multiqc/meta.yml cpan
modules/nf-core/sniffles/meta.yml cpan
modules/nf-core/tabix/bgzip/meta.yml cpan
modules/nf-core/tabix/tabix/meta.yml cpan
subworkflows/nf-core/utils_nextflow_pipeline/meta.yml cpan
subworkflows/nf-core/utils_nfcore_pipeline/meta.yml cpan
subworkflows/nf-core/utils_nfvalidation_plugin/meta.yml cpan
modules/local/automap/environment.yml pypi
modules/local/bnd_merge/environment.yml pypi
modules/local/clair3/environment.yml pypi
modules/local/consensus_gt/environment.yml pypi
modules/local/del_merge/environment.yml pypi
modules/local/dup_merge/environment.yml pypi
modules/local/filter/pass/environment.yml pypi
modules/local/filter/qual/environment.yml pypi
modules/local/format2info/environment.yml pypi
modules/local/format_vcf/environment.yml pypi
modules/local/get_vcf_fields/environment.yml pypi
modules/local/header_variants_vcf/environment.yml pypi
modules/local/ins_merge/environment.yml pypi
modules/local/inv_merge/environment.yml pypi
modules/local/mergetsv/environment.yml pypi
modules/local/nanocaller/environment.yml pypi
modules/local/postmerge/environment.yml pypi
modules/local/postvep/environment.yml pypi
modules/local/premerge/environment.yml pypi
modules/local/sample_info/environment.yml pypi
modules/local/software_info/environment.yml pypi
modules/local/splitvcfpvm/environment.yml pypi
modules/local/sv_samples/environment.yml pypi
modules/local/svim/environment.yml pypi
modules/local/vcftobed1/environment.yml pypi
modules/local/vcftobed2/environment.yml pypi
modules/nf-core/annotsv/annotsv/environment.yml pypi
modules/nf-core/annotsv/installannotations/environment.yml pypi
modules/nf-core/bcftools/merge/environment.yml pypi
modules/nf-core/bcftools/norm/environment.yml pypi
modules/nf-core/bcftools/query/environment.yml pypi
modules/nf-core/bcftools/sort/environment.yml pypi
modules/nf-core/bcftools/view/environment.yml pypi
modules/nf-core/cutesv/environment.yml pypi
modules/nf-core/ensemblvep/vep/environment.yml pypi
modules/nf-core/fastqc/environment.yml pypi
modules/nf-core/minimap2/align/environment.yml pypi
modules/nf-core/multiqc/environment.yml pypi
modules/nf-core/sniffles/environment.yml pypi
modules/nf-core/tabix/bgzip/environment.yml pypi
modules/nf-core/tabix/tabix/environment.yml pypi