Skip to main content

DOI Stars Compatible PyPI PyPiDownloads Docs Status

XClone

Inference of Clonal Copy Number Alterations in Single Cells

XClone is an algorithm to infer allele- and haplotype-specific copy numbers in individual cells from low-coverage and sparse single-cell RNA sequencing data (e.g., those generated by 10x Genomics, Smart-seq, etc.).

The demo of XClone and results on the all processed cancer datasets are available at xclone-data.

Please frequently read the tutorials and release history and keep software up to date since XClone is being updated and improved frequently at this stage.

./docs/image/XClone_overview_150dpi.png

Installation

Main Module

XClone requires Python 3.7 or Python >=3.9 (Recommend 3.9 for stable performance in latest version). Details of the environment requirements, see XClone FAQs.

We recommend to use Anaconda environment for version control and to avoid potential conflicts:

conda create -n xclone python=3.9
conda activate xclone

XClone package can be conveniently (1~2mins) installed via PyPI:

pip install xclone

or directly from GitHub repository (for development version):

pip install git+https://github.com/single-cell-genetics/XClone

Preprocessing via xcltk

xcltk is a toolkit for XClone preprocessing. xcltk is avaliable through pypi. To install, type the following command line, and add -U for upgrading:

pip install -U xcltk

Alternatively, you can install from this GitHub repository for latest (often development) version by following command line:

pip install -U git+https://github.com/hxj5/xcltk

User Guide

For a complete guide, please see XClone Documentation.

Documentation

Tutorials on demo dataset (Glioma sample, BCH869)

Tutorials on demo dataset (Triple-negative breast cancer sample, TNBC1)

Download the Jupyter Notebooks by clicking the following links:

Notebook on demo dataset (Glioma sample, BCH869)

Notebook on demo dataset (Triple-negative breast cancer sample, TNBC1)

Notebook on demo dataset (Anaplastic thyroid cancer sample, ATC2)

Notebook on demo dataset (Astrocytoma sample, GBM_10XsnRNA)

Ciatation

For details of the method, please checkout our paper Robust analysis of allele-specific copy number alterations from scRNA-seq data with XClone.

License

Licensed under the Apache License, Version 2.0 (see the LICENSE);

Copyright 2024 Rongting Huang, Yuanhua Huang, StatBiomed Lab

Metadata

Release files for xclone 0.4.0

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

Source distribution (sdist)

Source distribution for xclone 0.4.0
File Size Uploaded Provenance Actions
xclone-0.4.0.tar.gz 3.3 MB Without provenance Details for xclone-0.4.0.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for xclone 0.4.0
File Interpreter ABI Platform Actions
xclone-0.4.0-py3-none-any.whl Python 3 none any Details for xclone-0.4.0-py3-none-any.whl

Total release size: 6.8 MB

Release files / xclone-0.4.0.tar.gz

Download URL xclone-0.4.0.tar.gz
Size 3.3 MB
Tags Source
SHA-256 checksum
How to use checksums
908139585372bb83c6d0fcfbd057c20a50e045d58bd3becccad8cd173f92343e
BLAKE2b-256 checksum
How to use checksums
522d5001e517ead5d1fbed30e63b7518cd5f3a4bd541e63b0c1bfbf3eb2d5b4d
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.12.7

Release files / xclone-0.4.0-py3-none-any.whl

Download URL xclone-0.4.0-py3-none-any.whl
Size 3.4 MB
Tags Python 3
SHA-256 checksum
How to use checksums
8664ce25083c4b5fc0a21e854b6f62fe50b3ad932741fd411cd3843464319492
BLAKE2b-256 checksum
How to use checksums
32887dd23e39489419b484b502452dd9a9c377d690cc5d65c23a8a1eda997805
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.12.7

Security for xclone 0.4.0

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