ChIP-nexus processing pipeline

Introduction

ChIP-nexus pipeline

Features

• Flexibility: Support for docker, singularity and Conda.
• Portability: Support for many cloud platforms (Google/DNAnexus) and cluster engines (SLURM/SGE/PBS).
• Resumability: Resume a failed workflow from where it left off.
• User-friendly HTML report: tabulated quality metrics including alignment/peak statistics and FRiP along with many useful plots (IDR/cross-correlation measures).
• Genomes: Pre-built database for GRCh38, hg19, mm10, mm9 and additional support for custom genomes.

Installation and tutorial

This pipeline supports many cloud platforms and cluster engines. It also supports docker, singularity and Conda to resolve complicated software dependencies for the pipeline. A tutorial-based instruction for each platform will be helpful to understand how to run pipelines. There are special instructions for two major Stanford HPC servers (SCG4 and Sherlock).

• Cloud platforms
  • Web interface
  • DNAnexus Platform
  • CLI (command line interface)
  • Google Cloud Platform
  • DNAnexus Platform
• Stanford HPC servers (CLI)
  • Stanford SCG4
  • Stanford Sherlock 2.0
• Cluster engines (CLI)
  • SLURM
  • Sun GridEngine (SGE/PBS)
• Local computers (CLI)
  • Local system with singularity
  • Local system with docker
  • Local system with Conda

Input JSON file

Input JSON file specification

Output directories

Output directory specification

Useful tools

There are some useful tools to post-process outputs of the pipeline.

qc_jsons_to_tsv

This tool recursively finds and parses all qc.json (pipeline's final output) found from a specified root directory. It generates a TSV file that has all quality metrics tabulated in rows for each experiment and replicate. This tool also estimates overall quality of a sample by a criteria definition JSON file which can be a good guideline for QC'ing experiments.

resumer

This tool parses a metadata JSON file from a previous failed workflow and generates a new input JSON file to start a pipeline from where it left off.

ENCODE downloader

This tool downloads any type (FASTQ, BAM, PEAK, ...) of data from the ENCODE portal. It also generates a metadata JSON file per experiment which will be very useful to make an input JSON file for the pipeline.