CytoTable
Summary
Image-based profiling often entails preparing data for analysis by transforming the outputs of image analysis tools into a consistent, analysis-ready format.
CytoTable streamlines analyses by harmonizing CellProfiler (.csv or .sqlite), cytominer-database (.sqlite), DeepProfiler (.npz), or other sources such as IN Carta output data at scale.
This helps biologists by lowering the barrier between image acquisition and data interpretation, enabling them to focus on biological insights rather than file formats or data wrangling.
CytoTable creates Parquet or AnnData files for both independent analysis and for input into Pycytominer. The output files (such as Parquet and AnnData file formats) have a documented data model, including referenceable schema where appropriate (for validation within Pycytominer or other image-based profiling projects).
The name for the project is inspired by:
- Cyto: "1. (biology) cell." (Wiktionary: Cyto-)
- Table:
- "1. Furniture with a top surface to accommodate a variety of uses."
- "3.1. A matrix or grid of data arranged in rows and columns."
(Wiktionary: Table)
Installation
Install CytoTable from PyPI or from source:
# install from pypi
pip install cytotable
# install directly from source
pip install git+https://github.com/cytomining/CytoTable.git
Getting started
Check out the following resources to get started with CytoTable! We created tutorials which follow a narrative-driven approach. We also provide Jupyter notebooks for pragmatic, hands-on explanations.
We suggest image analysts begin with the tutorials and explore the example notebooks afterwards.
| Resource | What it covers | Link |
|---|---|---|
| Tutorial | CellProfiler SQLite or CSV to Parquet | Open tutorial |
| Tutorial | NPZ embeddings to Parquet | Open tutorial |
| Tutorial | Multi-plate merge with tablenumber | Open tutorial |
| Example notebook | CytoTable mise en place (general overview) | Open notebook |
| Example notebook | CytoTable from the cloud (cloud-based overview) | Open notebook |
Contributing, Development, and Testing
We test CytoTable using ubuntu-latest and macos-latest GitHub Actions runner images.
Please see contributing.md for more details on contributions, development, and testing.
Relationship to other projects
CytoTable focuses on image-based profiling data harmonization and serialization. At scale, CytoTable transforms data into file formats which can be directly integrated with:
Please let us know how you use CytoTable (we'd love to add your project to this list)!
- Pycytominer for the bioinformatics pipeline for image-based profiling.
- coSMicQC for quality control.
- CytoDataFrame for interactive visualization of profiles with single cell images.
References
2 maintainers
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file cytotable-1.2.4.tar.gz.
File metadata
- Download URL: cytotable-1.2.4.tar.gz
- Upload date:
- Size: 607.4 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
twine/7.0.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
4e8d18c97af1dfaef6ba5082bdfc3675c4cbb590dd21c6393ac08e05496356ca
|
|
| MD5 |
efa91ff44dfab2ddce7ffcaede4c8d0e
|
|
| BLAKE2b-256 |
619a4dd1d38a6296ba2452ca16aa1b30119652cb6255f62abe0aa681853f8bef
|
Provenance
The following attestation bundles were made for cytotable-1.2.4.tar.gz:
Publisher:
publish-pypi.yml on cytomining/CytoTable
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
cytotable-1.2.4.tar.gz -
Subject digest:
4e8d18c97af1dfaef6ba5082bdfc3675c4cbb590dd21c6393ac08e05496356ca - Sigstore transparency entry: 2408574889
- Sigstore integration time:
-
Permalink:
cytomining/CytoTable@5bf4ab6634cee0c22713dba0d533e8b07d71408d -
Branch / Tag:
refs/tags/v1.2.4 - Owner: https://github.com/cytomining
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish-pypi.yml@5bf4ab6634cee0c22713dba0d533e8b07d71408d -
Trigger Event:
release
-
Statement type:
File details
Details for the file cytotable-1.2.4-py3-none-any.whl.
File metadata
- Download URL: cytotable-1.2.4-py3-none-any.whl
- Upload date:
- Size: 68.3 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
twine/7.0.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
694974b21d224457df6d45be3276af8a3ffb5d7bcc13a64906f5553479c8ea49
|
|
| MD5 |
bf94abc38da4c9f8b343f1c5c95de566
|
|
| BLAKE2b-256 |
67ff9ea51f0d1f88f8212f16fcd0d2f9ed421f2f2d5b9abf7659ab5c5a7f71f7
|
Provenance
The following attestation bundles were made for cytotable-1.2.4-py3-none-any.whl:
Publisher:
publish-pypi.yml on cytomining/CytoTable
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
cytotable-1.2.4-py3-none-any.whl -
Subject digest:
694974b21d224457df6d45be3276af8a3ffb5d7bcc13a64906f5553479c8ea49 - Sigstore transparency entry: 2408575010
- Sigstore integration time:
-
Permalink:
cytomining/CytoTable@5bf4ab6634cee0c22713dba0d533e8b07d71408d -
Branch / Tag:
refs/tags/v1.2.4 - Owner: https://github.com/cytomining
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish-pypi.yml@5bf4ab6634cee0c22713dba0d533e8b07d71408d -
Trigger Event:
release
-
Statement type:
