Skip to main content

Convenient functions to streamline sc/snRNAseq data analysis workflow

Project description

DOTools_py

Tests Documentation Coverage Issues Stars PyPI PyPI Downloads

Convenient and user-friendly package to streamline common workflows in single-cell RNA sequencing data analysis using the scverse ecosystem. It provides high-level wrappers and visualization functions to help efficiently preprocess, analyze, and interpret single-cell data.

Getting started

Please refer to the documentation, in particular, the API documentation.

Installation

You need to have Python 3.10 or newer installed on your system. We recommend creating a dedicated conda environment.

conda create -n scrna_py11 python=3.11 -y
conda activate scrna_py11
pip install uv

There are several alternative options to install DOTools_py:

  1. Install the latest release of DOTools_py from PyPI:
uv pip install dotools-py
  1. Install the latest development version:
uv pip install git+https://github.com/davidrm-bio/DOTools_py.git@main

Finally, to use this environment in jupyter notebook, add jupyter kernel for this environment:

python -m ipykernel install --user --name=scrna_py11 --display-name=scrna_py11

Requirements

This package has been tested on macOS, Linux and Windows System. For a standard dataset (e.g., 6 samples with 10k cells each) we suggest 16GB of RAM and at least 5 CPUs.

Some methods are run through R and require additional dependencies including: Seurat, MAST, scDblFinder, zellkonverter, data.table and optparse.

if (!require("BiocManager", quietly = TRUE))
    install.packages("BiocManager")

install.packages("optparse", Ncpus=8)
install.packages('remotes', Ncpus=8)
install.packages('data.table', Ncpus = 8)
remotes::install_github("satijalab/seurat", "seurat5", quiet = TRUE)  # Seurat
BiocManager::install("MAST")
BiocManager::install("scDblFinder")
BiocManager::install("zellkonverter")
BiocManager::install('glmGamPoi')

For old CPU architectures there can be problems with polars making the kernel die when importing the package. In this case run

pip install --no-cache polars-lts-cpu

R version

We also have an R implementation of the DOTools. This can be installed from Bioconductor:

if (!requireNamespace("BiocManager", quietly=TRUE)) {
    install.packages("BiocManager")
}
BiocManager::install("DOtools")
devtools::install_github("MarianoRuzJurado/DOtools")

The developmental version can be downloaded using devtools:

devtools::install_github("MarianoRuzJurado/DOtools", ref="devel")

Release notes

See the changelog.

Contact

Raising up an issue in this GitHub repository might be the fastest way of submitting suggestions and bugs. Alternatively you can write to my email: rodriguezmorales@med.uni-frankfurt.de.

Citation

Ruz Jurado, Mariano, David Rodriguez Morales, Lukas Zanders, Elijah Genetzakis, Stefanie Dimmeler, and David John. 2026. “DoTools: A Cross Platform Framework to Streamline Common Single Cell Workflows.” Bioinformatics Advances: vbag098. https://doi.org/10.1093/bioadv/vbag098

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

dotools_py-0.0.4.tar.gz (10.5 MB view details)

Uploaded Source

Built Distribution

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

dotools_py-0.0.4-py3-none-any.whl (3.9 MB view details)

Uploaded Python 3

File details

Details for the file dotools_py-0.0.4.tar.gz.

File metadata

  • Download URL: dotools_py-0.0.4.tar.gz
  • Upload date:
  • Size: 10.5 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for dotools_py-0.0.4.tar.gz
Algorithm Hash digest
SHA256 1144c820b558b8d56cd157c8e9dc1e6bdeb09700bfad66c1ebb703fae79c4ea7
MD5 d6c219ea3161f21ef24197102c2397c3
BLAKE2b-256 e6cb1f5b0477e9b38dbee80ad0146ed68b033978980b6fcbed7757dd81e83d32

See more details on using hashes here.

Provenance

The following attestation bundles were made for dotools_py-0.0.4.tar.gz:

Publisher: release.yaml on davidrm-bio/DOTools_py

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file dotools_py-0.0.4-py3-none-any.whl.

File metadata

  • Download URL: dotools_py-0.0.4-py3-none-any.whl
  • Upload date:
  • Size: 3.9 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for dotools_py-0.0.4-py3-none-any.whl
Algorithm Hash digest
SHA256 afdbf6d02ef7fa8821e5a9fb31dd6c9f623f3a1e243e2710fe6c1b7f251567b0
MD5 3a2859debfa001594b4b840b23dd3735
BLAKE2b-256 63fdd6330e963590b60c7eac2d28487b7032c042899688436a039fc6984247f9

See more details on using hashes here.

Provenance

The following attestation bundles were made for dotools_py-0.0.4-py3-none-any.whl:

Publisher: release.yaml on davidrm-bio/DOTools_py

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

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