A Python package for creating a dataset for the Cell Feature Explorer.
Project description
Cell Feature Data
Python Package for Creating and Validating Cell Feature Datasets for Cell Feature Explore
Documentation
For full documentation, please see the full documentation on Github.
Install and Setup
pip install cell-feature-data
To create a new dataset using the package:
- Create a virtual environment if not already created:
python3 -m venv [ENV-PATH]
- Activate the virtual environment:
- On macOS/Linux:
source [ENV-PATH]/bin/activate
- On Windows:
[ENV-PATH]\Scripts\activate
- On macOS/Linux:
- Install the dependencies:
pip install cell-feature-data
. - Run
create-dataset
to start the dataset creation process. This will:- Request the path of the file you want to process. Formats supported:
.csv
, with more formats to be added as development progresses - Ask for an output path to save your dataset. If not specified, a new dataset folder is created in
data
, named after the input file - Process the input file and generate the necessary json files for the dataset
- Prompt for additional information about the dataset and update the json files accordingly
- Request the path of the file you want to process. Formats supported:
- Deactivate the virtual environment when finished:
deactivate
For more on what these files should look like, look at Full spec documentation
MIT license