Skip to content

HiCool

Bioc current

HiCool

v1.12.0 · 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

HiCool provides an R interface to process and normalize Hi-C paired-end fastq reads into .(m)cool files. .(m)cool is a compact, indexed HDF5 file format specifically tailored for efficiently storing HiC-based data. On top of processing fastq reads, HiCool provides a convenient reporting function to generate shareable reports summarizing Hi-C experiments and including quality controls.

Test coverage

Line coverage

Expression

Tests / Examples

Functions

10 6 exported

Complexity

4.9 avg / 18 max

Call network

10 nodes / 7 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

1,153

Files

29

Compiled share

0%

Has compiled src

No

Language breakdown

R 766 (66.4%)Tests 22 (1.9%)Docs 204 (17.7%)Vignettes 161 (14%)

API

Exported functions

6

Internal functions

4

Testing & CI

Has tests

Yes

Test-to-code ratio

0.03

testthat edition

3

CI present

Yes

CI type

["github-actions"]

PR gated

Yes

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

1

LOC over versions

v3.17: 1,219 LOCv3.18: 1,219 LOCv3.19: 1,219 LOCv3.20: 1,219 LOCv3.21: 1,219 LOCv3.22: 1,149 LOCv3.23: 1,153 LOC

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

Documentation

Documentation
READMEYes · 369 wordsVignettesYes · dynamicpkgdown siteNoNEWSNoCode of conductNoContributing guideNo
Examples that run
100%
Documented parameters
92%
Return-value docs
100%
References docs
0%

Topics

Depended on by (1)

Bioconductor (1)

People

Cite

Cite this package

Run in R for the authors' preferred citation:

citation("HiCool")
Serizay, J. (2026). HiCool: HiCool (Version 1.12.0) [Computer software]. https://bioconductor.org/packages/HiCool

This is what citation() produces when a package has no citation file of its own. If it prints something else, use that.

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 HiCool version 1.12.0 [Data set]. HJJB, LLC. Data release v2026-08-22. https://doi.org/10.5281/zenodo.21843040

From data release v2026-08-22, 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