biolearn


Namebiolearn JSON
Version 0.4.2 PyPI version JSON
download
home_pageNone
SummaryMachine learning for biomarkers computing
upload_time2024-05-04 17:25:31
maintainerNone
docs_urlNone
authorBiolearn developers
requires_python>=3.10
licensenew BSD
keywords biomarker
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            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>`_
            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "biolearn",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.10",
    "maintainer_email": "Martin Perez-Guevara <mperezguevara@gmail.com>",
    "keywords": "biomarker",
    "author": "Biolearn developers",
    "author_email": null,
    "download_url": "https://files.pythonhosted.org/packages/bc/04/319330d29e9c503f3e2ed4ffd0c8b02162efa868ac42a261bee8bed43091/biolearn-0.4.2.tar.gz",
    "platform": null,
    "description": "Biolearn\n========\n\nBiolearn enables easy and versatile analyses of biomarkers of aging data. It provides tools to easily load data from publicly available sources like the \n`Gene Expression Omnibus <https://www.ncbi.nlm.nih.gov/geo/>`_, `National Health and Nutrition Examimation Survey <https://www.cdc.gov/nchs/nhanes/index.htm>`_,\nand the `Framingham Heart Study <https://www.framinghamheartstudy.org/>`_. Biolearn also contains reference implemenations for common aging clock such at the \nHorvath 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>`_.\n\n\n.. warning::\n\n    This is a prerelease version of the biolearn library. There may be bugs and interfaces are subject to change.\n\n\nImportant links\n===============\n\n- Source code: https://github.com/bio-learn/biolearn/\n- Documentation Homepage: https://bio-learn.github.io/\n\nRequirements\n============\n\nPython 3.10+\n\nInstall\n=======\nInstall biolearn using pip.\n\n.. code-block:: bash\n\n    pip install biolearn\n\nTo verify the library was installed correctly open python or a jupyter notebook and run:\n\n.. code-block:: python\n\n    from biolearn.data_library import DataLibrary\n\nIf 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>`_\n\nDiscord server\n==============\n\nThe biolearn team has a `discord server <https://discord.gg/wZH85WRTxN>`_ to answer questions,\ndiscuss feature requests, or have any biolearn related discussions.\n\nIssues\n======\n\nIf you find any bugs with biolearn please create a Github issue including how we can replicate the issue and the expected vs actual behavior.\n\n\nContributing\n============\n\nDetailed instructions on developer setup and how to contribute are available `in the repo <https://github.com/bio-learn/biolearn/blob/master/DEVELOPMENT.md>`_",
    "bugtrack_url": null,
    "license": "new BSD",
    "summary": "Machine learning for biomarkers computing",
    "version": "0.4.2",
    "project_urls": null,
    "split_keywords": [
        "biomarker"
    ],
    "urls": [
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "5ee5504a01974eb1c1f264d1908b4d7de17b9e90fa210e9fbc60302efd857352",
                "md5": "8ecc5bea03a78cc8261404f3262b6f4e",
                "sha256": "4e4fb2e37a60a0b70cad6d22839ac2b20a62582a8ca6280d61e5221d28fe3c07"
            },
            "downloads": -1,
            "filename": "biolearn-0.4.2-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "8ecc5bea03a78cc8261404f3262b6f4e",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.10",
            "size": 12627243,
            "upload_time": "2024-05-04T17:25:27",
            "upload_time_iso_8601": "2024-05-04T17:25:27.030918Z",
            "url": "https://files.pythonhosted.org/packages/5e/e5/504a01974eb1c1f264d1908b4d7de17b9e90fa210e9fbc60302efd857352/biolearn-0.4.2-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "bc04319330d29e9c503f3e2ed4ffd0c8b02162efa868ac42a261bee8bed43091",
                "md5": "f14b0c40a0433d72d412b92354f26ea5",
                "sha256": "e47093523149bad50ddb75569355a23010e73e1674b326b79006eb6489d482a8"
            },
            "downloads": -1,
            "filename": "biolearn-0.4.2.tar.gz",
            "has_sig": false,
            "md5_digest": "f14b0c40a0433d72d412b92354f26ea5",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.10",
            "size": 13499289,
            "upload_time": "2024-05-04T17:25:31",
            "upload_time_iso_8601": "2024-05-04T17:25:31.530893Z",
            "url": "https://files.pythonhosted.org/packages/bc/04/319330d29e9c503f3e2ed4ffd0c8b02162efa868ac42a261bee8bed43091/biolearn-0.4.2.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-05-04 17:25:31",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "lcname": "biolearn"
}
        
Elapsed time: 0.26543s