Contents Menu Expand Light mode Dark mode Auto light/dark, in light mode Auto light/dark, in dark mode Skip to content
hictk documentation
hictk documentation

Installation

  • Installation
  • Installation (source)

FAQ

  • Frequently Asked Questions (FAQ)

Getting Started

  • Quickstart (CLI)
  • Quickstart (API)
  • Downloading test datasets
  • File validation
  • File metadata
  • Format conversion
  • Reading interactions
  • Creating .cool and .hic files
  • Creating multi-resolution files (.hic and .mcool)
  • Balancing Hi-C matrices

How-Tos

  • Reorder chromosomes
  • Dump interactions to .cool or .hic file

CLI and API Reference

  • CLI Reference
  • C++ API Reference
    • Generic API
    • Cooler API
    • Hi-C API
    • Shared Types
    • Pixel transformers
  • Python API
  • R API

Telemetry

  • Telemetry
Back to top
View this page

C++ API ReferenceΒΆ

hictk C++ API is structured as follows:

  • Generic API
  • Cooler API
  • Hi-C API
  • Shared Types
  • Pixel transformers
Next
Generic API
Previous
CLI Reference
Copyright © 2023, Roberto Rossini
Made with Sphinx and @pradyunsg's Furo