Metadata-Version: 2.1
Name: ctxcore
Version: 0.2.0
Summary: Core functions for pycisTarget and the SCENIC tool suite
Home-page: https://github.com/aertslab/ctxcore
Author: Bram Van de Sande, Gert Hulselmans
Maintainer: Gert Hulselmans
Maintainer-email: gert.hulselmans@kuleuven.be
License: GNU General Public License v3
Keywords: ctxcore,cisTarget,pycisTarget,SCENIC,pySCENIC,pycisTopic
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Requires-Dist: cytoolz
Requires-Dist: frozendict
Requires-Dist: numba (>=0.51.2)
Requires-Dist: numpy
Requires-Dist: pandas (>=0.24)
Requires-Dist: pyarrow (>=8.0.0)
Requires-Dist: pyyaml
Requires-Dist: tqdm

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.


