Skip to main content

Package for running the CIDR algorithm implemented in R, in python

Project description

rnadtu

A Python package for running the CIDR algorithm (originally implemented in R) for clustering single-cell RNA-seq data using AnnData objects.

Features

  • Run the CIDR algorithm from Python using:

    • cidr() — subprocess-based, using temporary CSV files (recommended for large datasets)
    • cidr_non_csv() — subprocess-based, using in-memory buffers (faster but memory intensive and difficult to debug)
    • cidr_rpy2() — uses the rpy2 bridge (direct R integration, less suitable for large datasets)
  • Optional configuration options:

    • data_type: default is "raw", can be "cpm" (counts per million)
    • n_cluster: default is None (CIDR calculates the optimal number), or manually specify an positive integer
    • layer: which layer of the AnnData object to use for input
    • Optional output controls:
      • pc: store principal coordinates
      • dissim: store dissimilarity matrix
      • dropout: store dropout matrix
      • save_clusters: (only in cidr_rpy2) choose store cluster labels (default True)
  • Results are saved in the AnnData object:

    • obsm[layer + "_cidr_pc"] — principal components
    • obsm[layer + "_cidr_clusters"] — cluster labels (if save_clusters=True)
    • obsp[layer + "_cidr_dissimilarity_matrix"] — pairwise distances
    • uns[layer + "_cidr_variation"], uns[layer + "_cidr_eigenvalues"] — PCA variation
    • uns[layer + "_cidr_dropout_candidates"] — dropout data
  • Generates a clustering plot in cidr_plots.pdf

Installation

pip install rnadtu

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

rnadtu-0.1.6.tar.gz (9.3 kB view details)

Uploaded Source

Built Distribution

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

rnadtu-0.1.6-py3-none-any.whl (10.8 kB view details)

Uploaded Python 3

File details

Details for the file rnadtu-0.1.6.tar.gz.

File metadata

  • Download URL: rnadtu-0.1.6.tar.gz
  • Upload date:
  • Size: 9.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.11.5

File hashes

Hashes for rnadtu-0.1.6.tar.gz
Algorithm Hash digest
SHA256 2c01df9da11d7ec2bbe0ece1e98aa9459571c33d91b2f27e28a80844f6dd3410
MD5 6e378dcb15a2b248f1348648c06648a1
BLAKE2b-256 efe562400e517bb8cd639e4fb26651bd8de2ac378f4e750131a4335ec288c7bc

See more details on using hashes here.

File details

Details for the file rnadtu-0.1.6-py3-none-any.whl.

File metadata

  • Download URL: rnadtu-0.1.6-py3-none-any.whl
  • Upload date:
  • Size: 10.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.11.5

File hashes

Hashes for rnadtu-0.1.6-py3-none-any.whl
Algorithm Hash digest
SHA256 e0cc0f31f2186a46210320379f6af714dff35d00af6604c922fae0bd1b00e633
MD5 8a7caf8c67334ae5b5e748ad40616464
BLAKE2b-256 941a454a9e45d9db633aa44df162005ba4daa7230c163882d1c0ea529b68e298

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