epical


Nameepical JSON
Version 1.1.0 PyPI version JSON
download
home_pageNone
Summaryepical --- Epigenetic age Calculator
upload_time2024-04-21 02:35:39
maintainerNone
docs_urlNone
authorNone
requires_python>=3.8
licenseCopyright (c) 2024 The Python Packaging Authority Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
keywords epigenetics age biological age dna methylation methylationepic 850k 450k rrbs wgbs
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            .. image:: https://readthedocs.org/projects/ansicolortags/badge/?version=latest
	:target: https://epical.readthedocs.io/?badge=latest

.. image:: https://img.shields.io/badge/Maintained%3F-yes-green.svg
	:target: https://GitHub.com/Naereen/StrapDown.js/graphs/commit-activity

.. image:: https://img.shields.io/badge/Made%20with-Python-1f425f.svg
	:target: https://www.python.org/

.. image:: https://img.shields.io/badge/Made%20with-Sphinx-1f425f.svg
	:target: https://www.sphinx-doc.org/


Installation
=============

*Epical* is coded in Python. It needs Python 3 (version 3.5.x) or a later
version for installation and execution.

Prerequisites
--------------

- `Python 3 <https://www.python.org/downloads/>`_
- `pip3 <https://pip.pypa.io/en/stable/installing/>`_
- `R <https://www.r-project.org/>`_
- `TensorFlow <https://www.tensorflow.org/>`_ (Only requires by *AltumAge*)

Python Dependencies
--------------------

- `pandas <https://pandas.pydata.org/>`_
- `numpy <http://www.numpy.org/>`_
- `scipy <https://www.scipy.org/>`_
- `sklearn <https://www.scilearn.com/>`_
- `bx-python <https://github.com/bxlab/bx-python>`_
- `matplotlib <https://matplotlib.org/>`_
- `EpigeneticPacemaker <https://epigeneticpacemaker.readthedocs.io/en/latest/>`_

.. note::
   Users do NOT need to install these packages manually, as they will be
   automatically installed if you use
   `pip3 <https://pip.pypa.io/en/stable/installing/>`_.

Install Epical
--------------
::

 # Create a  virtual environment ...

 # install from PyPI
 $ pip3 install epical

 # install from github
 $ pip3 install git+https://github.com/liguowang/epical.git

 # test if *epical* is available and excutable
 $ epical --version
 epical 0.0.1

.. note::
   If you used Python virtual environment to install
   `TensorFlow <https://www.tensorflow.org/>`_, you need to run the
   above command in the same virtual environment.


Upgrade *Epical*
-----------------
::

 $ pip3 install epical --upgrade

Uninstall *Epical*
-------------------
::

$ pip3 uninstall epical

Run *Epical*
============


Print out usage and all the `available clocks <https://epical.readthedocs.io/en/latest/overview.html#available-clocks>`_
-------------------------------------------------------------------------------------------------------------------------

::

 $ epical --help
  usage: epical [-h] [-v] 
  {Horvath13, Horvath13_shrunk, Horvath18, Levine, ...}
  ...

Example: run the "Horvath13" command
-------------------------------------

::
 
 # print usage of the "Horvath13" command
 $ epical Horvath13 --help
 ...
 
 # run example data
 $ epical Horvath13 -m blood_N20_info.tsv -o output blood_N20_MethylationEPIC-v1.0_beta.tsv.gz
 2024-01-04 07:52:11 [INFO]  The prefix of output files is set to "output".
 2024-01-04 07:52:11 [INFO]  Loading Horvath13 clock data ...
 2024-01-04 07:52:11 [INFO]  Clock's name: "Horvath13"
 2024-01-04 07:52:11 [INFO]  Clock was trained from: "Pan-tissue"
 2024-01-04 07:52:11 [INFO]  Clock's unit: "years"
 2024-01-04 07:52:11 [INFO]  Number of CpGs used: 353
 ...

Documentation
==============
`https://epical.readthedocs.io/en/latest/ <https://epical.readthedocs.io/en/latest/>`_

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "epical",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.8",
    "maintainer_email": "Liguo Wang <wangliguo78@gmail.com>",
    "keywords": "epigenetics age, biological age, DNA methylation, MethylationEPIC, 850K, 450K, RRBS, WGBS",
    "author": null,
    "author_email": "Liguo Wang <wangliguo78@gmail.com>",
    "download_url": "https://files.pythonhosted.org/packages/51/c9/2b76c11d1ad2360b6f7384328eb00c0a5d0eff8b956420f0005a2858d9d7/epical-1.1.0.tar.gz",
    "platform": null,
    "description": ".. image:: https://readthedocs.org/projects/ansicolortags/badge/?version=latest\n\t:target: https://epical.readthedocs.io/?badge=latest\n\n.. image:: https://img.shields.io/badge/Maintained%3F-yes-green.svg\n\t:target: https://GitHub.com/Naereen/StrapDown.js/graphs/commit-activity\n\n.. image:: https://img.shields.io/badge/Made%20with-Python-1f425f.svg\n\t:target: https://www.python.org/\n\n.. image:: https://img.shields.io/badge/Made%20with-Sphinx-1f425f.svg\n\t:target: https://www.sphinx-doc.org/\n\n\nInstallation\n=============\n\n*Epical* is coded in Python. It needs Python 3 (version 3.5.x) or a later\nversion for installation and execution.\n\nPrerequisites\n--------------\n\n- `Python 3 <https://www.python.org/downloads/>`_\n- `pip3 <https://pip.pypa.io/en/stable/installing/>`_\n- `R <https://www.r-project.org/>`_\n- `TensorFlow <https://www.tensorflow.org/>`_ (Only requires by *AltumAge*)\n\nPython Dependencies\n--------------------\n\n- `pandas <https://pandas.pydata.org/>`_\n- `numpy <http://www.numpy.org/>`_\n- `scipy <https://www.scipy.org/>`_\n- `sklearn <https://www.scilearn.com/>`_\n- `bx-python <https://github.com/bxlab/bx-python>`_\n- `matplotlib <https://matplotlib.org/>`_\n- `EpigeneticPacemaker <https://epigeneticpacemaker.readthedocs.io/en/latest/>`_\n\n.. note::\n   Users do NOT need to install these packages manually, as they will be\n   automatically installed if you use\n   `pip3 <https://pip.pypa.io/en/stable/installing/>`_.\n\nInstall Epical\n--------------\n::\n\n # Create a  virtual environment ...\n\n # install from PyPI\n $ pip3 install epical\n\n # install from github\n $ pip3 install git+https://github.com/liguowang/epical.git\n\n # test if *epical* is available and excutable\n $ epical --version\n epical 0.0.1\n\n.. note::\n   If you used Python virtual environment to install\n   `TensorFlow <https://www.tensorflow.org/>`_, you need to run the\n   above command in the same virtual environment.\n\n\nUpgrade *Epical*\n-----------------\n::\n\n $ pip3 install epical --upgrade\n\nUninstall *Epical*\n-------------------\n::\n\n$ pip3 uninstall epical\n\nRun *Epical*\n============\n\n\nPrint out usage and all the `available clocks <https://epical.readthedocs.io/en/latest/overview.html#available-clocks>`_\n-------------------------------------------------------------------------------------------------------------------------\n\n::\n\n $ epical --help\n  usage: epical [-h] [-v] \n  {Horvath13, Horvath13_shrunk, Horvath18, Levine, ...}\n  ...\n\nExample: run the \"Horvath13\" command\n-------------------------------------\n\n::\n \n # print usage of the \"Horvath13\" command\n $ epical Horvath13 --help\n ...\n \n # run example data\n $ epical Horvath13 -m blood_N20_info.tsv -o output blood_N20_MethylationEPIC-v1.0_beta.tsv.gz\n 2024-01-04 07:52:11 [INFO]  The prefix of output files is set to \"output\".\n 2024-01-04 07:52:11 [INFO]  Loading Horvath13 clock data ...\n 2024-01-04 07:52:11 [INFO]  Clock's name: \"Horvath13\"\n 2024-01-04 07:52:11 [INFO]  Clock was trained from: \"Pan-tissue\"\n 2024-01-04 07:52:11 [INFO]  Clock's unit: \"years\"\n 2024-01-04 07:52:11 [INFO]  Number of CpGs used: 353\n ...\n\nDocumentation\n==============\n`https://epical.readthedocs.io/en/latest/ <https://epical.readthedocs.io/en/latest/>`_\n",
    "bugtrack_url": null,
    "license": "Copyright (c) 2024 The Python Packaging Authority  Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:  The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.  THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. ",
    "summary": "epical --- Epigenetic age Calculator",
    "version": "1.1.0",
    "project_urls": {
        "Documentation": "https://epical.readthedocs.io/en/latest/",
        "Issues": "https://github.com/liguowang/epical/issues",
        "Repository": "https://github.com/liguowang/epical.git",
        "TestData": "https://sourceforge.net/projects/epical/files/"
    },
    "split_keywords": [
        "epigenetics age",
        " biological age",
        " dna methylation",
        " methylationepic",
        " 850k",
        " 450k",
        " rrbs",
        " wgbs"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "2ec31ca8f01add33a651166e8a2896714a4a2afcb5cc3900d8504717f30809bf",
                "md5": "55bdc7b4d3b35def175cdac33e7672e8",
                "sha256": "122554fd1bf688254e5695cf4a7a020d9adca02c9227f422b6275f251f36ab78"
            },
            "downloads": -1,
            "filename": "epical-1.1.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "55bdc7b4d3b35def175cdac33e7672e8",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.8",
            "size": 18716735,
            "upload_time": "2024-04-21T02:35:35",
            "upload_time_iso_8601": "2024-04-21T02:35:35.205568Z",
            "url": "https://files.pythonhosted.org/packages/2e/c3/1ca8f01add33a651166e8a2896714a4a2afcb5cc3900d8504717f30809bf/epical-1.1.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "51c92b76c11d1ad2360b6f7384328eb00c0a5d0eff8b956420f0005a2858d9d7",
                "md5": "cf6286ef2349053373a8b4e73e608915",
                "sha256": "156a971135bea28e33e65d5403f89a7445b7dc46993a60660670230ab463f246"
            },
            "downloads": -1,
            "filename": "epical-1.1.0.tar.gz",
            "has_sig": false,
            "md5_digest": "cf6286ef2349053373a8b4e73e608915",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.8",
            "size": 18491184,
            "upload_time": "2024-04-21T02:35:39",
            "upload_time_iso_8601": "2024-04-21T02:35:39.314185Z",
            "url": "https://files.pythonhosted.org/packages/51/c9/2b76c11d1ad2360b6f7384328eb00c0a5d0eff8b956420f0005a2858d9d7/epical-1.1.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-04-21 02:35:39",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "liguowang",
    "github_project": "epical",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": false,
    "lcname": "epical"
}
        
Elapsed time: 0.27432s