Giter VIP home page Giter VIP logo

bqsr-nf's Introduction

BQSR-nf

Nextflow pipeline for base quality score recalibration with GATK processing

CircleCI Docker Hub https://www.singularity-hub.org/static/img/hosted-singularity--hub-%23e32929.svg

Workflow representation

Decription

Nextflow pipeline for base quality score recalibration and quality control of bam files using GATK

Dependencies

  1. Nextflow: for common installation procedures see the IARC-nf repository.

  2. multiQC

  3. GATK4 must be in the PATH variable

  4. GATK bundle VCF files with lists of indels and SNVs (recommended: 1000 genomes indels, dbsnp VCF)

You can provide a config file to customize the multiqc report (see https://multiqc.info/docs/#configuring-multiqc).

Input

Type Description
--input_folder a folder with bam files

Parameters

  • Mandatory

Name Example value Description
--ref ref.fa reference genome fasta file for GATK
  • Optional

Name Default value Description
--cpu 2 number of CPUs
--mem 32 memory for mapping
--output_folder . output folder for aligned BAMs
--snp_vcf dbsnp.vcf VCF file with known variants for GATK BQSR
--indel_vcf Mills_100G_indels.vcf VCF file with known indels for GATK BQSR
--multiqc_config null config yaml file for multiqc
  • Flags

Name Description
--help print usage and optional parameters

Usage

To run the pipeline on a series of bam files in folder bam, a reference genome with indexes at ref.fa, and known snps and indels from the gatk bundle, one can type:

nextflow run iarcbioinfo/BQSR-nf --input_folder bam --ref ref.fa --snp_vcf GATK_bundle/dbsnp_146.hg38.vcf.gz --indel_vcf GATK_bundle/Mills_and_1000G_gold_standard.indels.hg38.vcf.gz

Output

Type Description
BAM/file.bam BAM files of alignments or realignments
BAM/file.bam.bai BAI files of alignments or realignments
QC/multiqc_BQSR_report.html multiqc report
QC/multiqc_BQSR_report_data folder with data used to compute multiqc report
QC/BAM/BQSR/file_recal.table table of scores before recalibration
QC/BAM/BQSR/file_post_recal.table table of scores after recalibration
QC/BAM/BQSR/file_recalibration_plots.pdf before/after recalibration plots

The output_folder directory contains two subfolders: BAM and QC

Directed Acyclic Graph

DAG BQSR

Contributions

Name Email Description
Nicolas Alcala* [email protected] Developer to contact for support

bqsr-nf's People

Contributors

nalcala avatar mfoll avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.