ctxcore
#######
|ctxcore|_ |buildstatus|_ |pypipackage|_ |docstatus|_
Core functions for pycisTarget and the SCENIC tool suite
----
ctxcore is part of the SCENIC Suite of tools!
See the main `SCENIC website <https://scenic.aertslab.org/>`_ for additional information and a full list of tools available.
----
Quickstart
==========
ctxcore is available on PyPI and can be installed with `pip <https://pip.pypa.io>`_.
.. code-block:: console
$ pip install ctxcore
After installing ctxcore you can use it like any other Python module.
Here is a simple example:
.. code-block:: python
import ctxcore
# Fill this section in with the common use-case.
The `API Reference <http://ctxcore.readthedocs.io>`_ provides API-level documentation.
.. |ctxcore| image:: https://img.shields.io/github/v/release/aertslab/ctxcore
:target: https://github.com/aertslab/ctxcore/releases
:alt: GitHub release (latest by date)
.. |buildstatus| image:: https://github.com/aertslab/ctxcore/actions/workflows/ci.yml/badge.svg
.. _buildstatus: https://github.com/aertslab/ctxcore/actions
.. |pypipackage| image:: https://img.shields.io/pypi/v/ctxcore?color=%23026aab
.. _pypipackage: https://pypi.org/project/ctxcore/
.. |docstatus| image:: https://readthedocs.org/projects/ctxcore/badge/?version=latest
.. _docstatus: https://ctxcore.readthedocs.io/en/latest/?badge=latest
.. _change-log-label:
Change Log
==========
Version History
---------------
0.2.0
* Remove unused RankingsDatabase classes and conversion functions.
* Add CisTargetDatabase class for reading rankings/scores for
regions/genes from a cisTarget scores or rankings database
(only Feather v2 format), which requires pyarrow >= 8.0.0
instead of <=0.17.1 needed for the old FeatherRankingDatabase
class.
* Update FeatherRankingDatabase to use CisTargetDatabase to read
cisTarget databases.
* Reformat code and update type annotations.
0.1.1
* Add support for reading rankings databases created by
create_cisTarget_databases as the index column in the
Feather file is "motifs" or "tracks" instead of "features".
0.1.0
* Project created.
Raw data
{
"_id": null,
"home_page": "https://github.com/aertslab/ctxcore",
"name": "ctxcore",
"maintainer": "Gert Hulselmans",
"docs_url": null,
"requires_python": "",
"maintainer_email": "gert.hulselmans@kuleuven.be",
"keywords": "ctxcore,cisTarget,pycisTarget,SCENIC,pySCENIC,pycisTopic",
"author": "Bram Van de Sande, Gert Hulselmans",
"author_email": "",
"download_url": "",
"platform": null,
"description": "ctxcore\n#######\n\n|ctxcore|_ |buildstatus|_ |pypipackage|_ |docstatus|_\n\nCore functions for pycisTarget and the SCENIC tool suite\n\n----\n\nctxcore is part of the SCENIC Suite of tools! \nSee the main `SCENIC website <https://scenic.aertslab.org/>`_ for additional information and a full list of tools available.\n\n----\n\n\n\nQuickstart\n==========\n\nctxcore is available on PyPI and can be installed with `pip <https://pip.pypa.io>`_.\n\n.. code-block:: console\n\n $ pip install ctxcore\n\nAfter installing ctxcore you can use it like any other Python module.\n\nHere is a simple example:\n\n.. code-block:: python\n\n import ctxcore\n # Fill this section in with the common use-case.\n\nThe `API Reference <http://ctxcore.readthedocs.io>`_ provides API-level documentation.\n\n.. |ctxcore| image:: https://img.shields.io/github/v/release/aertslab/ctxcore\n :target: https://github.com/aertslab/ctxcore/releases\n :alt: GitHub release (latest by date)\n\n.. |buildstatus| image:: https://github.com/aertslab/ctxcore/actions/workflows/ci.yml/badge.svg\n.. _buildstatus: https://github.com/aertslab/ctxcore/actions\n\n.. |pypipackage| image:: https://img.shields.io/pypi/v/ctxcore?color=%23026aab\n.. _pypipackage: https://pypi.org/project/ctxcore/\n\n.. |docstatus| image:: https://readthedocs.org/projects/ctxcore/badge/?version=latest\n.. _docstatus: https://ctxcore.readthedocs.io/en/latest/?badge=latest\n\n\n\n.. _change-log-label:\n\nChange Log\n==========\n\nVersion History\n---------------\n\n0.2.0\n * Remove unused RankingsDatabase classes and conversion functions.\n * Add CisTargetDatabase class for reading rankings/scores for\n regions/genes from a cisTarget scores or rankings database\n (only Feather v2 format), which requires pyarrow >= 8.0.0\n instead of <=0.17.1 needed for the old FeatherRankingDatabase\n class.\n * Update FeatherRankingDatabase to use CisTargetDatabase to read\n cisTarget databases.\n * Reformat code and update type annotations.\n\n\n0.1.1\n * Add support for reading rankings databases created by\n create_cisTarget_databases as the index column in the\n Feather file is \"motifs\" or \"tracks\" instead of \"features\".\n\n0.1.0\n * Project created.\n\n\n",
"bugtrack_url": null,
"license": "GNU General Public License v3",
"summary": "Core functions for pycisTarget and the SCENIC tool suite",
"version": "0.2.0",
"split_keywords": [
"ctxcore",
"cistarget",
"pycistarget",
"scenic",
"pyscenic",
"pycistopic"
],
"urls": [
{
"comment_text": "",
"digests": {
"md5": "d402a791ef2fea6f1984df4a5dc88c9a",
"sha256": "b90570377e26280c4861ebad1f4cee2fe598167c5d4bd12c1b713f03c9682627"
},
"downloads": -1,
"filename": "ctxcore-0.2.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "d402a791ef2fea6f1984df4a5dc88c9a",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 5837839,
"upload_time": "2022-06-24T14:31:07",
"upload_time_iso_8601": "2022-06-24T14:31:07.984887Z",
"url": "https://files.pythonhosted.org/packages/57/be/b60e62d10d80c80c5492739d6f2833ca2973bbc4088fcecf7053b5719da7/ctxcore-0.2.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2022-06-24 14:31:07",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "aertslab",
"github_project": "ctxcore",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"requirements": [
{
"name": "cytoolz",
"specs": []
},
{
"name": "frozendict",
"specs": []
},
{
"name": "numba",
"specs": [
[
">=",
"0.51.2"
]
]
},
{
"name": "numpy",
"specs": []
},
{
"name": "pandas",
"specs": [
[
">=",
"0.24"
]
]
},
{
"name": "pyarrow",
"specs": [
[
">=",
"8.0.0"
]
]
},
{
"name": "pyyaml",
"specs": []
},
{
"name": "tqdm",
"specs": []
}
],
"lcname": "ctxcore"
}
JSON
