Metadata-Version: 2.1
Name: biolearn
Version: 0.3.4
Summary: Machine learning for biomarkers computing
Author: Biolearn developers
Maintainer-email: Martin Perez-Guevara <mperezguevara@gmail.com>
License: new BSD
License-File: AUTHORS.rst
License-File: LICENSE
Keywords: biomarker
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: C
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Topic :: Scientific/Engineering
Classifier: Topic :: Software Development
Requires-Python: >=3.10
Requires-Dist: appdirs
Requires-Dist: numpy>=1.19.0
Requires-Dist: pandas
Requires-Dist: pyyaml
Requires-Dist: requests
Requires-Dist: scipy
Provides-Extra: dev
Requires-Dist: biolearn[doc,examples,plotting,test]; extra == 'dev'
Requires-Dist: jupyterlab; extra == 'dev'
Requires-Dist: scikit-learn; extra == 'dev'
Requires-Dist: torch; extra == 'dev'
Requires-Dist: torchvision; extra == 'dev'
Provides-Extra: doc
Requires-Dist: biolearn[examples,plotting]; extra == 'doc'
Requires-Dist: black; extra == 'doc'
Requires-Dist: coverage; extra == 'doc'
Requires-Dist: flake8; extra == 'doc'
Requires-Dist: flake8-docstrings; extra == 'doc'
Requires-Dist: furo; extra == 'doc'
Requires-Dist: memory-profiler; extra == 'doc'
Requires-Dist: mkl; extra == 'doc'
Requires-Dist: myst-parser; extra == 'doc'
Requires-Dist: numpydoc; extra == 'doc'
Requires-Dist: sphinx; extra == 'doc'
Requires-Dist: sphinx-copybutton; extra == 'doc'
Requires-Dist: sphinx-design; extra == 'doc'
Requires-Dist: sphinx-gallery; extra == 'doc'
Requires-Dist: sphinxcontrib-bibtex; extra == 'doc'
Requires-Dist: sphinxext-opengraph; extra == 'doc'
Provides-Extra: examples
Requires-Dist: lifelines; extra == 'examples'
Provides-Extra: plotting
Requires-Dist: matplotlib>=3.3.0; extra == 'plotting'
Requires-Dist: seaborn>=0.13.0; extra == 'plotting'
Provides-Extra: test
Requires-Dist: coverage; extra == 'test'
Requires-Dist: pytest-cov; extra == 'test'
Requires-Dist: pytest>=6.0.0; extra == 'test'
Description-Content-Type: text/x-rst

Biolearn
========

Biolearn enables easy and versatile analyses of biomarkers of aging data. It provides tools to easily load data from publicly available sources like the 
`Gene Expression Omnibus <https://www.ncbi.nlm.nih.gov/geo/>`_, `National Health and Nutrition Examimation Survey <https://www.cdc.gov/nchs/nhanes/index.htm>`_,
and the `Framingham Heart Study <https://www.framinghamheartstudy.org/>`_. Biolearn also contains reference implemenations for common aging clock such at the 
Horvath clock, DunedinPACE and many others that can easily be run in only a few lines of code. You can read more about it in our `paper <https://www.biorxiv.org/content/10.1101/2023.12.02.569722v2>`_.


.. warning::

    This is a prerelease version of the biolearn library. There may be bugs and interfaces are subject to change.


Important links
===============

- Source code: https://github.com/bio-learn/biolearn/
- Documentation Homepage: https://bio-learn.github.io/

Requirements
============

Python 3.10+

Install
=======
Install biolearn using pip.

.. code-block:: bash

    pip install biolearn

To verify the library was installed correctly open python or a jupyter notebook and run:

.. code-block:: python

    from biolearn.data_library import DataLibrary

If it executes with no errors then the library is installed. To get started check out `some code examples <https://bio-learn.github.io/auto_examples/index.html>`_

Discord server
==============

The biolearn team has a `discord server <https://discord.gg/wZH85WRTxN>`_ to answer questions,
discuss feature requests, or have any biolearn related discussions.

Issues
======

If you find any bugs with biolearn please create a Github issue including how we can replicate the issue and the expected vs actual behavior.


Contributing
============

Detailed instructions on developer setup and how to contribute are available `in the repo <https://github.com/bio-learn/biolearn/blob/master/DEVELOPMENT.md>`_