Skip to content

open2c/distiller-nf

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Jul 25, 2019
01f6f7b · Jul 25, 2019
Dec 24, 2018
Apr 5, 2019
Jul 25, 2019
May 14, 2017
Jul 24, 2019
Apr 27, 2017
Apr 25, 2017
Jul 25, 2019
Jul 24, 2019
Apr 25, 2017
May 13, 2019
Jul 24, 2019
Feb 13, 2019
Jul 24, 2019
Apr 5, 2019
Jul 8, 2019

Repository files navigation

distiller-nf

Build Status Join the chat at https://gitter.im/mirnylab/distiller DOI

A modular Hi-C mapping pipeline for reproducible data analysis.

The distiller pipeline aims to provide the following functionality:

  • Align the sequences of Hi-C molecules to the reference genome
  • Parse .sam alignment and form files with Hi-C pairs
  • Filter PCR duplicates
  • Aggregate pairs into binned matrices of Hi-C interactions

Installation

Requirements:

To setup a new project, execute the following line in the project folder:

$ nextflow clone mirnylab/distiller-nf ./

This will download the distiller pipeline and the configuration files.

Then:

  • configure the location of the input files and other project details in project.yml
  • configure additional parameters in nextflow.config
  • use provided hardware configurations using local and cluster profiles, or provide your own using custom profile

Launch distiller depending on your usage scenario:

  1. default hardware settings ./configs/local.config with your project.yml:
$ nextflow run distiller.nf -params-file project.yml
  1. cluster hardware profile ./configs/cluster.config with your project.yml:
$ nextflow run distiller.nf -params-file project.yml -profile cluster
  1. custom hardware profile with your own configuration file and your project.yml:
$ nextflow run distiller.nf -params-file project.yml -profile custom --custom_config /full/path/to/your.config

Test example

In a new project folder, execute:

$ nextflow clone mirnylab/distiller-nf  ./
$ bash setup_test.sh
$ nextflow distiller.nf -params-file ./test/test_project.yml