HiCDCPlus
Workflows
Standard Workflow
Systematic 3D interaction calls and differential analysis for Hi-C and HiChIP. The HiC-DC+ (Hi-C/HiChIP direct caller plus) package enables principled statistical analysis of Hi-C and HiChIP data sets – including calling significant interactions within a single experiment and performing differential analysis between conditions given replicate experiments – to facilitate global integrative studies. HiC-DC+ estimates significant interactions in a Hi-C or HiChIP experiment directly from the raw con
library(HiCDCPlus)
outdir <- tempdir()
# Generate genomic features (GC, mappability, effective length)
construct_features(
output_path = paste0(outdir, "/hg19_50kb_GATC"),
gen = "Hsapiens",
gen_ver = "hg19",
sig = "GATC",
bin_type = "Bins-uniform",
binsize = 50000,
chrs = "chr21"
)
# Initialize gi_list from the bintolen file
gi_list <- generate_bintolen_gi_list(
bintolen_path = paste0(outdir, "/hg19_50kb_GATC_bintolen.txt.gz")
)
# Expand 1D features to 2D for modeling
gi_list <- expand_1D_features(gi_list)
Input: Genome version, restriction enzyme pattern, and bin size; Output: A gi_list object containing 2D genomic features ready for interaction calling.
When to Use
- Chromatin Interaction Calling: To call significant 3D chromatin interactions from Hi-C or HiChIP data using
HiCDCPlus or HiCDCPlus_parallel.
- Differential Interaction Analysis: To perform differential interaction analysis across conditions with replicates using
hicdcdiff.
- Feature Generation: To generate genomic features (GC content, mappability, effective length) using
construct_features.
- TAD Calling: To find Topologically Associating Domains (TADs) using
gi_list_topdom.
- Compartment Analysis: To extract A/B compartments (eigenvectors) from
.hic files using extract_hic_eigenvectors.
When NOT to Use
- 1D Peak Calling: For standard 1D ChIP-seq peak calling, use
MACS2 or epigraHMM.
- RNA-seq Differential Expression: For RNA-seq differential expression, use standard
DESeq2 or edgeR directly.
Data Requirements
- Hi-C Formats: Hi-C data in
.hic, .matrix, or .allValidPairs formats.
- Enzyme Patterns: Restriction enzyme cut site patterns (e.g., "GATC").
- Reference Genome: Reference genome (e.g., "hg19", "hg38") and chromosome names.
Key Parameters
- bin_type ("Bins-uniform"): Type of binning, either "Bins-uniform" or "Bins-RE-sites".
- binsize (50000): Size of genomic windows or number of restriction fragments to merge.
- sig ("GATC"): Restriction enzyme recognition sequence.
- ssize (0.1): Downsampling rate of rows for modeling in
HiCDCPlus.
- mode ("normcounts"): Output mode for
hicdc2hic (e.g., 'pvalue', 'qvalue', 'normcounts', 'zvalue', 'raw').
- fitType ("mean"): Fit type for dispersion in
hicdcdiff.
Best Practices
- Feature Generation: Generate genomic features using
construct_features before initializing the gi_list to ensure GC and length biases are modeled.
- Feature Expansion: Expand 1D features to 2D using
expand_1D_features prior to running the negative binomial regression.
- Parallelization: Use
HiCDCPlus_parallel for efficient genome-wide interaction calling across multiple chromosomes.
- TAD Normalization: For TAD calling, perform ICE normalization first using
hic2icenorm_gi_list before running gi_list_topdom.
Common Pitfalls
- Missing Feature Expansion: Forgetting to expand 1D features to 2D before running
HiCDCPlus; always call expand_1D_features first.
- Chromosome Name Mismatch: Mismatched chromosome names between the feature files and count files; ensure consistent naming (e.g., "chr21" vs "21").
- Insufficient Replicates: Insufficient replicates for differential analysis; use
hicdcdiff with biological replicates to ensure robust statistical power.
Alternatives
- diffHic: For differential interaction analysis using sliding windows.
- HiTC: For basic Hi-C data manipulation and ICE normalization.
- FitHiC: For calling significant interactions.
Citations
- Sahin, M., Wong, W., Zhan, Y., Van Deyze, K., Koche, R., and Leslie, C. S. (2021) HiC-DC+: systematic 3D interaction calls and differential analysis for Hi-C and HiChIP. Nature Communications, 12(3366).
References
1---2name: hicdcplus3description: HiCDCPlus4---56# HiCDCPlus78## Workflows910### Standard Workflow1112Systematic 3D interaction calls and differential analysis for Hi-C and HiChIP. The HiC-DC+ (Hi-C/HiChIP direct caller plus) package enables principled statistical analysis of Hi-C and HiChIP data sets – including calling significant interactions within a single experiment and performing differential analysis between conditions given replicate experiments – to facilitate global integrative studies. HiC-DC+ estimates significant interactions in a Hi-C or HiChIP experiment directly from the raw con1314```r15library(HiCDCPlus)16outdir <- tempdir()1718# Generate genomic features (GC, mappability, effective length)19construct_features(20 output_path = paste0(outdir, "/hg19_50kb_GATC"),21 gen = "Hsapiens",22 gen_ver = "hg19",23 sig = "GATC",24 bin_type = "Bins-uniform",25 binsize = 50000,26 chrs = "chr21"27)2829# Initialize gi_list from the bintolen file30gi_list <- generate_bintolen_gi_list(31 bintolen_path = paste0(outdir, "/hg19_50kb_GATC_bintolen.txt.gz")32)3334# Expand 1D features to 2D for modeling35gi_list <- expand_1D_features(gi_list)36```37*Input: Genome version, restriction enzyme pattern, and bin size; Output: A gi_list object containing 2D genomic features ready for interaction calling.*3839## When to Use40- **Chromatin Interaction Calling**: To call significant 3D chromatin interactions from Hi-C or HiChIP data using `HiCDCPlus` or `HiCDCPlus_parallel`.41- **Differential Interaction Analysis**: To perform differential interaction analysis across conditions with replicates using `hicdcdiff`.42- **Feature Generation**: To generate genomic features (GC content, mappability, effective length) using `construct_features`.43- **TAD Calling**: To find Topologically Associating Domains (TADs) using `gi_list_topdom`.44- **Compartment Analysis**: To extract A/B compartments (eigenvectors) from `.hic` files using `extract_hic_eigenvectors`.4546## When NOT to Use47- **1D Peak Calling**: For standard 1D ChIP-seq peak calling, use `MACS2` or `epigraHMM`.48- **RNA-seq Differential Expression**: For RNA-seq differential expression, use standard `DESeq2` or `edgeR` directly.4950## Data Requirements51- **Hi-C Formats**: Hi-C data in `.hic`, `.matrix`, or `.allValidPairs` formats.52- **Enzyme Patterns**: Restriction enzyme cut site patterns (e.g., "GATC").53- **Reference Genome**: Reference genome (e.g., "hg19", "hg38") and chromosome names.5455## Key Parameters56- **bin_type** ("Bins-uniform"): Type of binning, either "Bins-uniform" or "Bins-RE-sites".57- **binsize** (50000): Size of genomic windows or number of restriction fragments to merge.58- **sig** ("GATC"): Restriction enzyme recognition sequence.59- **ssize** (0.1): Downsampling rate of rows for modeling in `HiCDCPlus`.60- **mode** ("normcounts"): Output mode for `hicdc2hic` (e.g., 'pvalue', 'qvalue', 'normcounts', 'zvalue', 'raw').61- **fitType** ("mean"): Fit type for dispersion in `hicdcdiff`.6263## Best Practices64- **Feature Generation**: Generate genomic features using `construct_features` before initializing the `gi_list` to ensure GC and length biases are modeled.65- **Feature Expansion**: Expand 1D features to 2D using `expand_1D_features` prior to running the negative binomial regression.66- **Parallelization**: Use `HiCDCPlus_parallel` for efficient genome-wide interaction calling across multiple chromosomes.67- **TAD Normalization**: For TAD calling, perform ICE normalization first using `hic2icenorm_gi_list` before running `gi_list_topdom`.6869## Common Pitfalls70- **Missing Feature Expansion**: Forgetting to expand 1D features to 2D before running `HiCDCPlus`; always call `expand_1D_features` first.71- **Chromosome Name Mismatch**: Mismatched chromosome names between the feature files and count files; ensure consistent naming (e.g., "chr21" vs "21").72- **Insufficient Replicates**: Insufficient replicates for differential analysis; use `hicdcdiff` with biological replicates to ensure robust statistical power.7374## Alternatives75- **diffHic**: For differential interaction analysis using sliding windows.76- **HiTC**: For basic Hi-C data manipulation and ICE normalization.77- **FitHiC**: For calling significant interactions.7879## Citations80- Sahin, M., Wong, W., Zhan, Y., Van Deyze, K., Koche, R., and Leslie, C. S. (2021) HiC-DC+: systematic 3D interaction calls and differential analysis for Hi-C and HiChIP. Nature Communications, 12(3366).8182## References83- Homepage: bioconductor.org/packages/HiCDCPlus84- Vignette: https://bioconductor.org/packages/release/bioc/vignettes/HiCDCPlus/inst/doc/HiCDCPlus.html