Skip to main content

Send mutation signature data to ExploSig

Project description

Build Status

ExploSig Connect

Helpers for sending data from a Python environment to ExploSig (via ExploSig Server) for web-based interactive visualization.

Installation

pip install explosig-connect

Example Usage - Connecting to an existing session

>>> from explosig_connect import connect

>>> # Connect using a session ID supplied by ExploSig.
>>> session_id = 'af6242f3'
>>> conn = connect(session_id)

>>> # Obtain the SBS mutation counts matrix associated with the session.
>>> sbs_counts_df = conn.get_counts_by_category('SBS')

>>> # You run some custom code to derive better signature exposures.
>>> exposures_df = my_exposures_computation_method(sbs_counts_df)

>>> # Send the new exposures back to ExploSig for visualization.
>>> conn.send_exposures('SBS', exposures_df)

Example Usage - Starting a new session

>>> from explosig_connect import connect

>>> # Start a new 'empty' session with no samples, signatures, etc. selected.
>>> # This will attempt to open ExploSig in a new browser tab that starts the session.
>>> conn = connect()

>>> # Send an SBS mutation counts matrix to visualize.
>>> conn.send_counts('SBS', my_sbs_counts_df)

>>> # Send an exposures matrix to visualize.
>>> conn.send_exposures('SBS', my_sbs_exposures_df)

>>> # Send a signatures matrix to visualize.
>>> conn.send_signatures('SBS', my_sbs_signatures_df)

Development

Build and install from the current directory.

python setup.py sdist bdist_wheel
pip install .

Use the hostname parameter to specify a custom ExploSig instance. There is also a password parameter to enable usage with protected instances.

>>> conn = connect(session_id, hostname='http://localhost:8100')

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

explosig-connect-0.0.1.tar.gz (4.2 kB view hashes)

Uploaded Source

Built Distribution

explosig_connect-0.0.1-py3-none-any.whl (5.7 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page