.. housekeepingMinerPy documentation master file, created by
   sphinx-quickstart on Thu Aug 15 17:59:29 2024.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.


Welcome to housekeepingMinerPy's documentation
==============================================

**housekeepingMinerPy** is a Python library for mine housekeeping genes in RNA-seq experiments.
The package was developed during the paper **Housekeeping Gene Expression Normalization in Transcriptomics Mitigates Data Leakage in Machine Learning Models**.

You can easily calculate the Gini coefficient, coefficient of variation, and coefficient of variation on the stability of genes. You can cluster similar genes that can be potentially considered control genes. With low variance in different conditions. Below is an example of stable genes found in the peripheral blood of kidney-transplanted patients.

.. image:: ex1.png
  :width: 100%
  :alt: Application example

.. toctree::
   :maxdepth: 2
   :caption: Contents:

   README
   modules



Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`