Git Product home page Git Product logo

chipimputation's Introduction

Imputation Workflow h3abionet/chipimputation

Build Status

Nextflow

install with bioconda Docker Singularity Container available

Introduction

Imputation is likely to be run in the context of a GWAS, studying population structure, and admixture studies. It is computationally expensive in comparison to other GWAS steps. The basic steps of the pipeline is description in the diagram below:

chipimputation pipeline workflow diagram

The workflow was developed using Nextflow. The imputation is performed using Minimac4. It identifies regions to be imputed on the basis of an input file in VCF format, split the regions into small chunks, phase each chunk using the phasing tool Eagle2 and produces output in VCF format that can subsequently be used in a GWAS workflow. It also produce basic plots and reports of the imputation process including the imputation performance report, the imputation accuracy, the allele frequency of the imputed vs of the reference panel and other metrics.

It comes with docker/singularity containers making installation trivial and results highly reproducible. This workflow which was developed as part of the H3ABioNet Hackathon held in Pretoria, SA in 2016.

  • We track our open tasks using github's issues

Documentation

The h3achipimputation pipeline comes with documentation about the pipeline, found in the docs/ directory:

  1. Installation
  2. Pipeline configuration
  3. Running the pipeline
  4. Output and how to interpret the results
  5. Troubleshooting

Getting started

Basic test using test data

This pipeline itself needs no installation - NextFlow will automatically fetch it from GitHub. You can run the pipeline using test data hosted in github with singularity without have to install or change any parameters.

nextflow run imputation.nf -profile test,singularity

Check for results in ./output

wc -l output/impute_results/*

Setup (native cluster)

Headnode

  • Nextflow (can be installed as local user)
  • NXF_HOME needs to be set, and must be in the PATH
  • Note that we've experienced problems running Nextflow when NXF_HOME is on an NFS mount.
  • The Nextflow script also needs to be invoked in a non-NFS folder
  • Java 1.8+

Compute nodes

  • The compute nodes need access to shared storage for input, references, output.
  • If you opt to use singularity no software installation will be needed.
  • Otherwise, the following commands/softwares need to be available in PATH on the compute nodes
    • minimac4 from Minimac4
    • eagle from Eagle
    • vcftools from VCFtools
    • bcftoolsfrom bcftools
    • bgzip from htslib
    • python2.7
    • R with the following packages ggplot2, dplyr, data.table, sm, optparse, ggsci

chipimputation's People

Contributors

ameintjes avatar dondelelcaro avatar dschreyer avatar mamanambiya avatar mturkson23 avatar

Watchers

 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.