Welcome! This repository will allow you to measure the quality and reproducibility of 3D genome data. It computes the following:
Quality scores per sample using
Reproducibility for pairs of samples using
Make sure you have R>=3.4.0 (needed for HiCRep).
Install Anaconda2, which contains python as well as a set of commonly used packages. 3DChromatin_ReplicateQC is compatible with Python 2.
First clone the repository:
git clone http://github.com/kundajelab/3DChromatin_ReplicateQC
Then, run the following installation command:
Note if you are installing locally: There are a few parameters you can provide to the installation script, to point it to your desired python installation (where you installed anaconda, e.g.
/home/anaconda/bin/python), R installation, R library and modules. Thus, you can run the above as described in the following example.
Assume the following:
module load <module name>
Then, your installation commands would look as below:
3DChromatin_ReplicateQC/install_scripts/install_3DChromatin_ReplicateQC.sh --pathtopython /home/my_anaconda2/bin/python --pathtor /home/my_R/bin/R --rlib /home/my_R_libraries --modules module1,module2`
Note that to call
3DChromatin_ReplicateQC you will need to use the full path to it, which will be in the example above
/home/my_anaconda2/bin/3DChromatin_ReplicateQC, rather than simply
Say you want to compare 2 contact maps. For this example, we will use a subset of datasets from Rao et al., 2014. First, configure the files used in the example:
Then run all methods (both QC and reproducibility as follows):
cd 3DChromatin_ReplicateQC 3DChromatin_ReplicateQC run_all --metadata_samples examples/metadata.samples --metadata_pairs examples/metadata.pairs --bins examples/Bins.w50000.bed.gz --outdir examples/output
The scores are summarized in the output directory under
Notes about the genomewide scores
Note that the genomewide scores are computed as follows:
Also note that the genomewide scores are computed considering all chromosomes by default. If the option
--subset_chromosomes is used, then the genomewide score refers to the genomewide score obtained by considering only the subset of chromosomes specified in
Before running 3DChromatin_ReplicateQC, make sure to have the following files:
contact map For each of your samples, you need a file containing the counts assigned to each pair of bins in your contact map, and should have the format
chr1 bin1 chr2 bin2 value. Note: 3DChromatin_ReplicateQC assumes that this file contains the contacts for all chromosomes, and will split it into individual files for each chromosome.
bins This file contains the full set of genomic regions associated with your contact maps, in the format
chr start end name where name is the name of the bin as used in the contact map files above. 3DChromatin_ReplicateQC supports both fixed-size bins and variable-sized bins (e.g. obtained by partitioning the genome into restriction fragments).
3DChromatin_ReplicateQC takes the following inputs:
--metadata_samples Information about the samples being compared. Tab-delimited file, with columns "samplename", "samplefile". Note: each samplename should be unique. Each samplefile listed here should follow the format "chr1 bin1 chr2 bin2 value
--metadata_pairs Each row is a pair of sample names to be compared, in the format "samplename1 samplename2". Important: sample names used here need to correspond to the first column of the --metadata_samples file.
--bins A (gzipped) bed file of the all bins used in the analysis. It should have 4 columns: "chr start end name", where the name of the bin corresponds to the bins used in the contact maps.
--re_fragments Add this flag if the bins are not uniform bins in the genome (e.g. if they are restriction-fragment-based).By default, the code assumes the bins are of uniform length.
--methods Which method to use for measuring concordance or QC. Comma-delimited list. Possible methods: "GenomeDISCO", "HiCRep", "HiC-Spector", "QuASAR-Rep", "QuASAR-QC". By default all methods are run
--parameters_file File with parameters for reproducibility and QC analysis. For details see "Parameters file"
--outdir Name of output directory. DEFAULT: replicateQC
--running_mode The mode in which to run the analysis. This allows you to choose whether the analysis will be run as is, or submitted as a job through sge or slurm. Available options are: "NA" (default, no jobs are submitted). Coming soon: "sge", "slurm"
--concise_analysis Set this flag to obtain a concise analysis, which means replicateQC is measured but plots that might be more time/memory consuming are not created. This is useful for quick testing or running large-scale analyses on hundreds of comparisons.
--subset_chromosomes Comma-delimited list of chromosomes for which you want to run the analysis. By default the analysis runs on all chromosomes for which there are data. This is useful for quick testing
To analyze multiple pairs of contact maps (or multiple contact maps if just computing QC), all you need to do is add any additional datasets you want to analyze to the
--metadata_samples file and any additional pairs of datasets you want to compare to the
The parameters file specifies the parameters to be used with 3DChromatin_ReplicateQC. The format of the file is:
method_name parameter_name parameter_value. The default parameters file used by 3DChromatin_ReplicateQC is:
GenomeDISCO|subsampling lowest GenomeDISCO|tmin 3 GenomeDISCO|tmax 3 GenomeDISCO|norm sqrtvc GenomeDISCO|scoresByStep no GenomeDISCO|removeDiag yes GenomeDISCO|transition yes HiCRep|h 5 HiCRep|maxdist 5000000 HiC-Spector|n 20 QuASAR|rebinning resolution SGE|text "-l h_vmem=3G" slurm|text "--mem 3G"
Note: all of the above parameters need to be specified in the parameters file.
Here are details about setting these parameters:
GenomeDISCO|subsampling This allows subsampling the datasets to a specific desired sequencing depth. Possible values are:
lowest (subsample to the depth of the sample with the lower sequencing depth from the pair being compared),
GenomeDISCO|tmin The minimum number of steps of random walk to perform. Integer, > 0.
GenomeDISCO|tmax The max number of steps of random walk to perform. Integer, > tmin.
GenomeDISCO|norm The normalization to use on the data when running GenomeDISCO. Possible values include:
uniform (no normalization),
GenomeDISCO|scoresByStep Whether to report the score at each t. By default (GenomeDISCO|scoresByStep no), only the final reproducibility score is returned.
GenomeDISCO|removeDiag Whether to set the diagonal to entries in the contact map to 0. By default (GenomeDISCO|removeDiag yes), the diagonal entries are set to 0.
GenomeDISCO|transition Whether to convert the normalized contact map to an appropriate transition matrix before running the random walks. By default (GenomeDISCO|transition yes) the normalized contact map is converted to a proper transition matrix, such that all rows sum to 1 exactly.
HiCRep|h The h parameter in HiCRep that determines the extent of 2D smoothing. See the HiCRep paper (http://genome.cshlp.org/content/early/2017/08/30/gr.220640.117) for details. Integer, >=0.
HiCRep|maxdist The maximum distance to consider when computing the HiCRep score. Integer, should be a amultiple of the resolution of the data.
HiC-Spector|nThe number of eigenvectors to use for HiC-Spector. Integer, > 0.
QuASAR|rebinningThe rebinning distance. See the QuASAR paper (https://www.biorxiv.org/content/early/2017/10/17/204438) for details. Integer.
Job submission parameters
SGE|text Text to append to the job submission for SGE. The default is "-l h_vmem=3G".
slurm|text Text to append to the job submission for slurm. The default is "--mem 3G".
Note about normalization: At the moment, the different methods operate on different types of normalizations. For GenomeDISCO, the user can specify the desired normalization. For HiCRep and HiC-Spector the scores are computed on the provided data, without normalization.
Thus, if you have normalized data, then you can provide that as an input, and set
GenomeDISCO|norm to uniform. If you have raw data, then your HiCRep and HiC-Spector scores will be run on the raw data, and GenomeDISCO will be run on the normalization you specify with
3DChromatin_ReplicateQC consists of multiple steps, which are run in sequence by default. However, the user may decide to run the steps individually, which can be useful for instance when running 3DChromatin_ReplicateQC with job submission engines that runs the comparisons in parallel as separate jobs.
Preprocesses all datasets provided in
3DChromatin_ReplicateQC preprocess --metadata_samples examples/metadata.samples --bins examples/Bins.w50000.bed.gz --outdir examples/output --parameters_file examples/example_parameters.txt
Runs QC methods on all samples provided in
--metadata_samples. Note that this step is only compatible with
--methods QuASAR-QC, since this is the only method that provides sample-level quality scores. If you provide any other methods to this step in addition to QuASAR-QC, they will not be run.
3DChromatin_ReplicateQC qc --metadata_samples examples/metadata.samples --outdir examples/output --methods QuASAR-QC
Runs reproducibility methods on all samples pairs provided in
--metadata_pairs. Note that the only methods that can be run with this step are: GenomeDISCO, HiCRep, HiC-Spector and QuASAR-Rep. If QuASAR-QC is provided here, it will not be run.
3DChromatin_ReplicateQC concordance --metadata_pairs examples/metadata.pairs --outdir examples/output --methods GenomeDISCO,HiCRep,HiC-Spector,QuASAR-Rep
Summarizes scores across all comparisons.
3DChromatin_ReplicateQC summary --metadata_samples examples/metadata.samples --metadata_pairs examples/metadata.pairs --bins examples/Bins.w50000.bed.gz --outdir examples/output --methods GenomeDISCO,HiCRep,HiC-Spector,QuASAR-Rep,QuASAR-QC
Clean up superfluous files, leaving only the scores.
3DChromatin_ReplicateQC cleanup --outdir examples/output
It is possible to run 3DChromatin_ReplicateQC with job submission engines, specifically either SGE or slurm.
To do so, modify the parameters
slurm|text respectively, to add any additional parameters to the job run.
Then, run the steps sequentially (that is, wait for all jobs of a given step to complete before launching the next step), while specifying
--running_mode to either
For instance, an example analysis workflow for SGE would be:
3DChromatin_ReplicateQC preprocess --running_mode sge --metadata_samples examples/metadata.samples --bins examples/Bins.w50000.bed.gz --outdir examples/output --parameters_file examples/example_parameters.txt 3DChromatin_ReplicateQC qc --running_mode sge --metadata_samples examples/metadata.samples --outdir examples/output --methods QuASAR-QC 3DChromatin_ReplicateQC concordance --running_mode sge --metadata_pairs examples/metadata.pairs --outdir examples/output --methods GenomeDISCO,HiCRep,HiC-Spector,QuASAR-Rep 3DChromatin_ReplicateQC summary --running_mode sge --metadata_samples examples/metadata.samples --metadata_pairs examples/metadata.pairs --bins examples/Bins.w50000.bed.gz --outdir examples/output --methods GenomeDISCO,HiCRep,HiC-Spector,QuASAR-Rep,QuASAR-QC 3DChromatin_ReplicateQC cleanup --running_mode sge --outdir examples/output
Similarly, for slurm, change sge to slurm for the
Contact Oana Ursu (firstname.lastname@example.org)
Or submit an issue for this repository.
This repository was put together by Oana Ursu. Thanks to Michael Sauria for providing wrapper scripts around the QuASAR method, Tao Yang for his assistance in integrating HiCRep into this repository, and Koon-Kiu Yan for his assistance in integrating HiC-Spector into this repository.
Thanks to the Noble lab (Gurkan Yardminci, Jie Liu, Charles Grant), as well as Michael Sauria for testing the code out and for suggestions for improvement.
docker (coming soon)
Thanks to Anna Shcherbina for help making this code dockerized.