be-datahive 0.1.0

A Python wrapper for the BEDATAHIVE API

be-datahive

Python library for the BE-dataHIVE API.

Installation

be_datahive is available on PYPI. Install with pip:

pip install be_datahive

Documentation

Create an api object for interacting with the API:

from be_datahive import be_datahive
api = be_datahive()

Obtain efficiency & bystander data:

efficiency_data = api.get_efficiency()
bystander_data = api.get_bystander()

Convert efficiency & bystander data into machine-ready arrays:

ef_features, ef_target = api.get_efficiency_ml_arrays(efficiency_data, encoding='one-hot')
by_features, by_target = api.get_bystander_ml_arrays(bystander_data, encoding='one-hot')

Citation

When using the BE-dataHIVE API, please cite our paper as outlined below.

@article{Schneider.2023,
    title = "BE-dataHIVE: a Base Editing Database",
    author = "Lucas Schneider, Peter Minary",
    year = "2023",
}