Skip to content

HiCExperiment

Bioc current

Bioconductor class for interacting with Hi-C files in R

v1.12.0 · Package record · software · MIT + file LICENSE

Release Lineage

Entered 3.17 · Apr 26, 2023

Current · Requires R 4.6

1.0 In 7 of 49 releases 3.23

Description

R generic interface to Hi-C contact matrices in `.(m)cool`, `.hic` or HiC-Pro derived formats, as well as other Hi-C processed file formats. Contact matrices can be partially parsed using a random access method, allowing a memory-efficient representation of Hi-C data in R. The `HiCExperiment` class stores the Hi-C contacts parsed from local contact matrix files. `HiCExperiment` instances can be further investigated in R using the `HiContacts` analysis package.

Advisories

None published for Bioconductor

Test coverage

Line coverage

–

Expression

–

Tests / Examples

–

Functions

65 12 exported

Complexity

3.5 avg / 20 max

Call network

65 nodes / 123 edges

Test coverage is not measured for Bioconductor packages; nodes fall back to a neutral fill.

Loading call graph…

Lowest coverage

Per-function coverage is not measured for this package yet.

Code

Structure

Lines of code

7,091

Files

71

Compiled share

0%

Has compiled src

No

Language breakdown

R 4,986 (70.3%)Tests 449 (6.3%)Docs 1,348 (19%)Vignettes 308 (4.3%)

API

Exported functions

14

Internal functions

52

Testing

Has tests

Yes

Test-to-code ratio

0.09

testthat edition

3

Docs

Roxygen coverage

100%

Health & Security signals

Informational signals; not verdicts.

on.exit coverage

0%

Unsafe pattern score

0

Dep constraint coverage

0%

Secret pattern count

0

Bundled 3rd-party code

2 items

Portability & License

Min R version

4.2

System requirements

–

C++ standard

–

License

MIT + file LICENSE

License flags

SPDX valid, OSI approved

History

Versions

7

First release

2023-04-25

Latest release

2026-04-28

Avg cadence

182 days

Cold removal rate

–

Dep drift

2

LOC over versions

v3.17: 6,319 LOCv3.18: 6,985 LOCv3.19: 7,065 LOCv3.20: 7,066 LOCv3.21: 7,076 LOCv3.22: 7,091 LOCv3.23: 7,091 LOC

Per-file churn detail lives in the source pipeline: https://github.com/r-observatory/bioc-code-metrics.

Documentation

In the Bioconductor 3.23 release
READMEYes · 583 wordsVignettesYes · 1 · dynamicNEWSNoCitation fileYes · cites a publication
Help pages
21 (9 internal)
Examples that run
100%11 run in a plain check
Exported functions with examples
89%
Documented parameters
63%
Return-value docs
22%
Help pages citing references
0%

Repository practices

Upstream repositoryBeta

6 development-tooling and community-health practices detected across 3 families in the upstream repository

Checks run against github.com/js2264/hicexperiment on 2026-10-21.

Continuous integration (2)
GitHub ActionsR CMD check workflow

The R CMD check workflow runs on Linux, macOS and Windows, and on R-devel

Docs source (2)
pkgdown

GitHub Pages site last deployed 2026-10-05

Reproducibility and dev environment (2)
MakefileDockerfile
How this is detected·Detection ruleset v4 (2026-10-20)

Datasets

Bundled datasets · 1
NameClassSizeAlso in
centros_yeast–––

All of HiCExperiment's data objects

Topics

Maintainer
Jacques Serizay

Available on

CRANr2uBioconductorautoCRANCOPR

Depended on by (6)

People

Cite

Cite this package

Run in R for the authors' entry:

citation("HiCExperiment")

The package provides a citation file, so citation() returns the authors' own entry.

It points to 10.1038/s41467-024-44761-x.

Cite the R Observatory

For a number measured here: a download total, a coverage figure, an archival date.

APA

Balamuta, J. J. (2026). R Observatory: Metrics for HiCExperiment version 1.12.0 [Data set]. HJJB, LLC. Data release v2026-10-23. https://doi.org/10.5281/zenodo.21843040

From data release v2026-10-23, which the citation names so these numbers can be found later. More on citing and the projects behind them.

Report a problem with this page →

Privacy choices

These apply to this browser and are stored on this device only. Nothing about your choice is sent to us.

Read the privacy policy