Sparse binary format for genomic interaction matrices.
Project description
Cooler
Latest Release | |
License | |
Build Status | |
Pre-commit Status | |
Docs Status | |
Coverage | |
Downloads | |
Citation | |
Community |
A cool place to store your Hi-C
Cooler is a support library for a sparse, compressed, binary persistent storage format, also called cooler, used to store genomic interaction data, such as Hi-C contact matrices.
The cooler file format is an implementation of a genomic matrix data model using HDF5 as the container format. The cooler
package includes a suite of command line tools and a Python API to facilitate creating, querying and manipulating cooler files.
To get started:
- Install cooler
- Read the documentation and see the Jupyter Notebook walkthrough.
- cool files from published Hi-C data sets are available at
ftp://cooler.csail.mit.edu/coolers
. - Many more multires (mcool) files are available on the 4DN data portal.
Installation
Install from PyPI using pip.
$ pip install cooler
If you are using conda
, you can alternatively install cooler
from the bioconda channel.
$ conda install -c conda-forge -c bioconda cooler
Citing
Abdennur, N., and Mirny, L.A. (2020). Cooler: scalable storage for Hi-C data and other genomically labeled arrays. Bioinformatics. doi: 10.1093/bioinformatics/btz540.
@article{cooler2020,
author = {Abdennur, Nezar and Mirny, Leonid A},
title = "{Cooler: scalable storage for Hi-C data and other genomically labeled arrays}",
journal={Bioinformatics},
volume={36},
number={1},
pages={311--316},
year={2020},
doi = {10.1093/bioinformatics/btz540},
url = {https://doi.org/10.1093/bioinformatics/btz540},
}
Contributing
Interested in contributing to cooler? That's great! To get started, check out the contributing guide.
Related projects
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for cooler-0.9.0-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 68de5f670e04f6725facbd0aae0d9161e7a8dde8e0fd624a901e0b1d672e7d6b |
|
MD5 | 751538b0f5f75b1d2e524ae3033e7507 |
|
BLAKE2b-256 | e319c2f2a9aa34968445e35bd17e42cd93e6e263d0e67155cd8f37abd517b59c |