BandHiC documentation

Version: 0.3.0

Welcome to the BandHiC documentation!

This documentation provides a comprehensive guide to the BandHiC library, including its features, installation instructions, and API reference. It is designed to help you efficiently store and manipulate Hi-C contact matrices in a banded form, enabling NumPy-compatible operations, matrix masking, diagonal reduction, file I/O, and domain-level interaction analysis.

If you have any questions, please contact us:

Author: Wang Weibing

Email: wangweibing@xidian.edu.cn

Useful links: PDF Download | Website | PyPI | GitHub

Contents

• Quick Start
  • Overview
  • Installation
  • What is BandHiC?
• Tutorials
  • Prerequisites
  • Import bandhic package
  • Initialize a band_hic_matrix object
  • Load or save a band_hic_matrix object
  • Construct a band_hic_matrix object
  • Indexing on band_hic_matrix
  • Masking
  • Universal functions (ufunc)
  • Other Array Functions
• API Reference
  • band_hic_matrix Class
  • Creation Functions
  • Input/Output Functions
  • Vectorized operations for BandHiC matrices
  • Data Reduction and Normalization
  • Other Functions

Indices and Tables

• Index

• Module Index

• Search Page