Skip to main content

Liver Annotation

Liver Annotation is a Python package designed to annotate clusters in single-cell RNA sequencing (scRNA-seq) data from liver samples. This package provides a machine learning model that is specifically trained on liver cells, enabling out-of-the-box functionality without the need for pre-existing expert-annotated data.

Features

  • Machine learning model trained specifically on liver cells.
  • Supports both neural network and random forest classifier models.
  • Annotates clusters using either the most common annotation or probability-based methods.

Installation

To install the package, use pip:

pip install liver_annotation

Usage

Classification of Cells

You can classify cells by cell type using the classify_cells function. The function requires an input in_data which is a standard scanpy/anndata object with gene expression data.

from liver_annotation import classify_cells

# Example usage
classify_cells(ann_data_obj, species="human", model_type="nn")
  • species: Choose between "human" or "mouse".
  • model_type: Choose between "rfc" (random forest classifier) or "nn" (neural network).

Cluster Annotation

Annotate clusters using the cluster_annotations function. This function requires an input in_data and allows you to specify the clustering algorithm and model type.

from liver_annotation import cluster_annotations

# Example usage
cluster_annotations(in_data, species="human", clusters="louvain", algorithm="mode", model_type="nn")
  • clusters: The column in in_data.obs to use for cluster data.
  • algorithm: Choose between "mode" or "prob" for cluster annotation.
  • model_type: Choose between "rfc" or "nn".

Dependencies

  • torch
  • joblib
  • scipy
  • numpy
  • scanpy

License

This project is licensed under the MIT License - see the LICENSE file for details.

Contributing

Contributions are welcome! Please open an issue or submit a pull request for any improvements or bug fixes.

Contact

For any questions or issues, please contact Madhavendra Thakur at madhavendra.thakur@gmail.com.

Metadata

Release files for liver-annotation 0.1.2

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for liver-annotation 0.1.2
File Size Uploaded Provenance
liver_annotation-0.1.2.tar.gz 5.4 kB Without provenance Details

Built distribution (wheel)

Table of built distributions (wheels) for liver-annotation 0.1.2
File Interpreter ABI Platform
liver_annotation-0.1.2-py3-none-any.whl Python 3 none any Details

Total release size: 11.2 kB

Release files / liver_annotation-0.1.2.tar.gz

Download URL liver_annotation-0.1.2.tar.gz
Size 5.4 kB
Tags Source
SHA-256 checksum
How to use checksums
6e92baf08c458f0d5e1581fb80dc292016a698220297efc8867c932355ecc66d
BLAKE2b-256 checksum
How to use checksums
89a7b68debd628a9e58a10cbff32859d3fc7ccf6b9e2ad99df3d309eb3c38355
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/5.1.1 CPython/3.10.0

Release files / liver_annotation-0.1.2-py3-none-any.whl

Download URL liver_annotation-0.1.2-py3-none-any.whl
Size 5.8 kB
Tags Python 3
SHA-256 checksum
How to use checksums
3ef3a78cf43474d5104429a3bfddf8e0f6f7e550ed54bb5a2c1e4e904fa9ca39
BLAKE2b-256 checksum
How to use checksums
5131272f10f8d8b5baac24d39940a0dea47787924553dda03f881d71dc04e720
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/5.1.1 CPython/3.10.0

Security for liver-annotation 0.1.2

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page