Skip to main content

A machine learning model for classification of cells and annotation of clusters in scRNA-seq data from liver samples.

Project description

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.

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

liver_annotation-0.1.2.tar.gz (5.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

liver_annotation-0.1.2-py3-none-any.whl (5.8 kB view details)

Uploaded Python 3

File details

Details for the file liver_annotation-0.1.2.tar.gz.

File metadata

  • Download URL: liver_annotation-0.1.2.tar.gz
  • Upload date:
  • Size: 5.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.10.0

File hashes

Hashes for liver_annotation-0.1.2.tar.gz
Algorithm Hash digest
SHA256 6e92baf08c458f0d5e1581fb80dc292016a698220297efc8867c932355ecc66d
MD5 62ad6336afc4e25a7afa53150f2100c0
BLAKE2b-256 89a7b68debd628a9e58a10cbff32859d3fc7ccf6b9e2ad99df3d309eb3c38355

See more details on using hashes here.

File details

Details for the file liver_annotation-0.1.2-py3-none-any.whl.

File metadata

File hashes

Hashes for liver_annotation-0.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 3ef3a78cf43474d5104429a3bfddf8e0f6f7e550ed54bb5a2c1e4e904fa9ca39
MD5 8fc284105dd9efa8cda287a4fe2bfe0f
BLAKE2b-256 5131272f10f8d8b5baac24d39940a0dea47787924553dda03f881d71dc04e720

See more details on using hashes here.

Supported by

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