Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Micro-c build matrix support #914

Merged
merged 6 commits into from
Nov 28, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,8 @@
HiCExplorer
===========

Set of programs to process, analyze and visualize Hi-C and cHi-C data
---------------------------------------------------------------------
Set of programs to process, analyze and visualize Hi-C, Micro-C and cHi-C data
------------------------------------------------------------------------------

Sequencing techniques that probe the 3D organization of the genome generate large amounts of data whose processing,
analysis and visualization is challenging. Here, we present HiCExplorer, a set of tools for the analysis and
Expand All @@ -26,7 +26,7 @@ of contacts, TAD detection, A/B compartments, merging, reordering or chromosomes
`cooler <https://github.com/mirnylab/cooler>`_ and detection of long-range contacts. Moreover, it allows the visualization of
multiple contact matrices along with other types of data like genes, compartments, ChIP-seq coverage tracks (and in general
any type of genomic scores), long range contacts and the visualization of viewpoints.

With version 3.7.6 we introduce the support for Micro-C data for the build of matrices.

Single-cell Hi-C data
---------------------
Expand Down
10 changes: 9 additions & 1 deletion azure-pipelines.yml
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,10 @@ jobs:
python.version: '3.9'
Python310:
python.version: '3.10'

Python311:
python.version: '3.11'
Python312:
python.version: '3.12'

steps:
- bash: |
Expand Down Expand Up @@ -66,6 +69,11 @@ jobs:
python.version: '3.9'
Python310:
python.version: '3.10'
Python311:
python.version: '3.11'
Python312:
python.version: '3.12'


steps:
- bash: |
Expand Down
7 changes: 7 additions & 0 deletions bin/hicBuildMatrixMicroC
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
#!/usr/bin/env python
# -*- coding: utf-8 -*-

from hicexplorer.hicBuildMatrixMicroC import main

if __name__ == "__main__":
main()
8 changes: 8 additions & 0 deletions docs/content/News.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,14 @@
News and Developments
=====================

Release 3.7.6
-------------
**27 November 2024**

- Add a new hicBuildMatrixMicroC script to build matrices from Micro-C data. It is the same as hicBuildMatrix but without the enforcement of the restriction cut site file, restriction sequence and dangling end since this is not necessary for Micro-C data.
- Update to include support for Python 3.11 and 3.12


Release 3.7.5
-------------
**June 2024**
Expand Down
3 changes: 3 additions & 0 deletions docs/content/list-of-tools.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ Tools for Hi-C data pre-processing

tools/hicFindRestSite
tools/hicBuildMatrix
tools/hicBuildMatrixMicroC
tools/hicSumMatrices
tools/hicMergeMatrixBins
tools/hicCorrectMatrix
Expand Down Expand Up @@ -98,6 +99,8 @@ For single-cell Hi-C data analysis please use `scHiCExplorer <https://schicexplo
+--------------------------------------+------------------+-----------------------------------+---------------------------------------------+-----------------------------------------------------------------------------------+
|:ref:`hicBuildMatrix` | preprocessing | 2 BAM/SAM files | hicMatrix object | Creates a Hi-C matrix using the aligned BAM files of the Hi-C sequencing reads |
+--------------------------------------+------------------+-----------------------------------+---------------------------------------------+-----------------------------------------------------------------------------------+
|:ref:`hicBuildMatrixMicroC` | preprocessing | 2 BAM/SAM files | hicMatrix object | Creates a Hi-C matrix using the aligned BAM files of the Hi-C sequencing reads |
+--------------------------------------+------------------+-----------------------------------+---------------------------------------------+-----------------------------------------------------------------------------------+
|:ref:`hicCorrectMatrix` | preprocessing | hicMatrix object | normalized hicMatrix object | Uses iterative correction or Knight-Ruiz to remove biases from a Hi-C matrix |
+--------------------------------------+------------------+-----------------------------------+---------------------------------------------+-----------------------------------------------------------------------------------+
|:ref:`hicMergeMatrixBins` | preprocessing | hicMatrix object | hicMatrix object | Merges consecutive bins on a Hi-C matrix to reduce resolution |
Expand Down
2 changes: 1 addition & 1 deletion hicexplorer/_version.py
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,4 @@
# This file is originally generated from Git information by running 'setup.py
# version'. Distribution tarballs contain a pre-generated copy of this file.

__version__ = '3.7.5'
__version__ = '3.7.6'
Loading
Loading