clone2vec 0.1.0__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1,86 @@
1
+ Metadata-Version: 2.4
2
+ Name: clone2vec
3
+ Version: 0.1.0
4
+ Summary: Package for an analysis of lineage-tracing scRNA-Seq data
5
+ Home-page: https://github.com/kharchenkolab/clone2vec
6
+ Author: Sergey Isaev
7
+ Author-email: s@isaev.cc
8
+ Classifier: Programming Language :: Python :: 3
9
+ Classifier: License :: OSI Approved :: MIT License
10
+ Classifier: Operating System :: OS Independent
11
+ Requires-Python: >=3.8
12
+ Description-Content-Type: text/markdown
13
+ Requires-Dist: pynndescent
14
+ Requires-Dist: scanpy
15
+ Requires-Dist: scikit-learn
16
+ Requires-Dist: torch
17
+ Requires-Dist: joblib
18
+ Requires-Dist: statsmodels
19
+ Requires-Dist: tqdm
20
+ Provides-Extra: test
21
+ Requires-Dist: catboost; extra == "test"
22
+ Requires-Dist: geosketch; extra == "test"
23
+ Requires-Dist: fastglmpca; extra == "test"
24
+ Requires-Dist: mpltern; extra == "test"
25
+ Requires-Dist: textalloc; extra == "test"
26
+ Provides-Extra: full
27
+ Requires-Dist: catboost; extra == "full"
28
+ Requires-Dist: geosketch; extra == "full"
29
+ Requires-Dist: fastglmpca; extra == "full"
30
+ Requires-Dist: mpltern; extra == "full"
31
+ Requires-Dist: textalloc; extra == "full"
32
+ Requires-Dist: anywidget; extra == "full"
33
+ Requires-Dist: ipywidgets; extra == "full"
34
+ Requires-Dist: jupyter-scatter; extra == "full"
35
+ Requires-Dist: rpy2; extra == "full"
36
+ Requires-Dist: mudata; extra == "full"
37
+
38
+ <p align="center"><a href="https://clone2vec.readthedocs.io/en/latest/"><img src="docs/source/logo.png" height="150"></a></p>
39
+
40
+ # clone2vec
41
+
42
+ ![Tests](https://github.com/kharchenkolab/clone2vec/actions/workflows/tests.yml/badge.svg)
43
+ ![PyPI](https://img.shields.io/pypi/v/clone2vec)
44
+ ![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)
45
+
46
+ clone2vec is a Python package for analysis of lineage tracing coupled with single-cell RNA-Seq.
47
+
48
+ The main key of the package are clonal embeddings — vector representations of the whole clones
49
+ in low dimensional space. These representations is a dropout-robust and cluster-free
50
+ way of representation of heterogeneity within clonal behaviour for cell type tree-free hypothesis
51
+ generation regarding cells' multipotency.
52
+
53
+ clone2vec builds representation of clones in exact same way with popular word embedding algorithm — word2vec —
54
+ via construction two-layers fully connected neural network (it uses Skip-Gram architecture) that
55
+ aims to predict neighbour cells clonal labellings by clonal label of cells. As a result, clones that exist in
56
+ similar context in gene expression space will have similar weights in this neural network, and these weights
57
+ will be used as embedding for further analysis.
58
+
59
+ ## Benchmarking illustrations
60
+
61
+ See [Technical Note](https://github.com/kharchenkolab/clone2vec/blob/main/docs/Technical_note.pdf) for more details.
62
+
63
+ ## Installation
64
+
65
+ clone2vec might be installed via `pip` (takes 1-2 minutes on Google Colab):
66
+ ```bash
67
+ pip install clone2vec
68
+ ```
69
+ or the latest development version can be installed from GitHub using:
70
+ ```bash
71
+ pip install git+https://github.com/kharchenkolab/clone2vec
72
+ ```
73
+
74
+ ## System requirements
75
+
76
+ `clone2vec` requires Python 3.8 or later with packages listed in [setup.cfg](setup.cfg) file. The package was successfully tested
77
+ on the following systems:
78
+
79
+ * macOS Sonoma 14.5 (Apple M1 Chip @ 3.20GHz × 8, 16GB RAM) — *MacBook Air M1*,
80
+ * Ubuntu 18.04.5 LTS, 64-bit (Intel Xeon @ 2.60GHz × 32, 256GB RAM) — *PowerEdge server*,
81
+ * Ubuntu 22.04.3 LTS, 64-bit (Intel Xeon @ 2.20GHz × 2, 13GB RAM) — *Google Colab*.
82
+
83
+ ## Documentation and tutorials
84
+
85
+ Please visit [documentation web-site](https://clone2vec.readthedocs.io/en/latest/) to check out API description and a few
86
+ tutorials with analysis.
@@ -0,0 +1,49 @@
1
+ <p align="center"><a href="https://clone2vec.readthedocs.io/en/latest/"><img src="docs/source/logo.png" height="150"></a></p>
2
+
3
+ # clone2vec
4
+
5
+ ![Tests](https://github.com/kharchenkolab/clone2vec/actions/workflows/tests.yml/badge.svg)
6
+ ![PyPI](https://img.shields.io/pypi/v/clone2vec)
7
+ ![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)
8
+
9
+ clone2vec is a Python package for analysis of lineage tracing coupled with single-cell RNA-Seq.
10
+
11
+ The main key of the package are clonal embeddings — vector representations of the whole clones
12
+ in low dimensional space. These representations is a dropout-robust and cluster-free
13
+ way of representation of heterogeneity within clonal behaviour for cell type tree-free hypothesis
14
+ generation regarding cells' multipotency.
15
+
16
+ clone2vec builds representation of clones in exact same way with popular word embedding algorithm — word2vec —
17
+ via construction two-layers fully connected neural network (it uses Skip-Gram architecture) that
18
+ aims to predict neighbour cells clonal labellings by clonal label of cells. As a result, clones that exist in
19
+ similar context in gene expression space will have similar weights in this neural network, and these weights
20
+ will be used as embedding for further analysis.
21
+
22
+ ## Benchmarking illustrations
23
+
24
+ See [Technical Note](https://github.com/kharchenkolab/clone2vec/blob/main/docs/Technical_note.pdf) for more details.
25
+
26
+ ## Installation
27
+
28
+ clone2vec might be installed via `pip` (takes 1-2 minutes on Google Colab):
29
+ ```bash
30
+ pip install clone2vec
31
+ ```
32
+ or the latest development version can be installed from GitHub using:
33
+ ```bash
34
+ pip install git+https://github.com/kharchenkolab/clone2vec
35
+ ```
36
+
37
+ ## System requirements
38
+
39
+ `clone2vec` requires Python 3.8 or later with packages listed in [setup.cfg](setup.cfg) file. The package was successfully tested
40
+ on the following systems:
41
+
42
+ * macOS Sonoma 14.5 (Apple M1 Chip @ 3.20GHz × 8, 16GB RAM) — *MacBook Air M1*,
43
+ * Ubuntu 18.04.5 LTS, 64-bit (Intel Xeon @ 2.60GHz × 32, 256GB RAM) — *PowerEdge server*,
44
+ * Ubuntu 22.04.3 LTS, 64-bit (Intel Xeon @ 2.20GHz × 2, 13GB RAM) — *Google Colab*.
45
+
46
+ ## Documentation and tutorials
47
+
48
+ Please visit [documentation web-site](https://clone2vec.readthedocs.io/en/latest/) to check out API description and a few
49
+ tutorials with analysis.
@@ -0,0 +1,23 @@
1
+ from . import tools as tl
2
+ from . import plotting as pl
3
+ from . import datasets
4
+ from . import preprocessing as pp
5
+ from . import utils
6
+ from . import seurat
7
+
8
+ __version__ = "2.0.1"
9
+
10
+ # Restrict top-level tab-completion to submodules only
11
+ __all__ = [
12
+ "tl",
13
+ "pl",
14
+ "pp",
15
+ "utils",
16
+ "datasets",
17
+ "seurat",
18
+ "__version__",
19
+ ]
20
+
21
+ def __dir__():
22
+ # Return curated names for completion engines
23
+ return sorted(__all__)