tascCODA
Tree-aggregated compositional analysis for high-throughput sequencing data
tascCODA extends the scCODA model (Büttner, Ostner et al., 2021) with a method to perform sparse, tree-aggregated modeling of high-throughput sequencing data. Hereby, tascCODA can infer credible changes on the features (i.e. cell types/ASVs/taxa) of a high-throughput sequencing dataset, as well as effects on subgroups of the set of features, which are defined by a tree structure, for example a cell lineage hierarchy or a taxonomic tree.
The statistical methodology and benchmarking performance are described here:
Code for reproducing the analysis from the paper is available here.
Installation
Running the package requires a working Python environment (>=3.8).
This package uses the tensorflow (>=2.8) and tensorflow-probability (>=0.16) packages.
The GPU computation features of these packages have not been tested with tascCODA and are thus not recommended.
To install tascCODA via pip, call:
pip install tasccoda
To install tascCODA from source:
-
Navigate to the directory that you want to install tascCODA in
-
Clone the repository from Github:
git clone https://github.com/bio-datascience/tascCODA -
Navigate to the root directory of tascCODA:
cd tascCODA -
Install dependencies::
pip install -r requirements.txt -
Install the package:
python setup.py install
Usage
Import tascCODA in a Python session via:
import tasccoda
You can then import a dataset in the same way as scCODA (see here for an instruction on scCODA's data structure)
Once you imported your dataset, add a toytree tree object, for example generated from a Newick string, as data.uns["phylo_tree"].
Then, initialize your analysis object, together with your formula and reference feature (see the scCODA documentation for explanations).
To set the aggregation bias, pass "phi" as a key in the pen_args parameter
`model = tasccoda.tree_ana.CompositionalAnalysisTree(
data,
reference_cell_type="9",
formula="x_0",
pen_args={"phi":phi},
)
`
Then, run HMC sampling with dual-averaging step size adaptation by calling:
`result = model.sample_hmc_da()`
Finally, you can look at result.node_df to find credible effects of covariates on tree nodes
or plot a tree with indicators for credible effects with result.draw_tree_effects()
Metadata
Release files for tascCODA 0.1.3
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| tascCODA-0.1.3.tar.gz | 18.7 kB | Without provenance | Details for tascCODA-0.1.3.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| tascCODA-0.1.3-py3-none-any.whl | Python 3 | none | any | Details for tascCODA-0.1.3-py3-none-any.whl |
Total release size: 39.1 kB
Release files / tascCODA-0.1.3.tar.gz
| Download URL | tascCODA-0.1.3.tar.gz |
|---|---|
| Size | 18.7 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
8c12ddccb72c41c96c6a5abceb52e7a76f439a9ab94fb092aa86ee3c1292383a
|
|
BLAKE2b-256 checksum How to use checksums |
e3413f327659348c7b96713bb098a5b4f0b588df96d30ed9477b100dff9bdec2
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.3.0 pkginfo/1.6.1 requests/2.25.1 setuptools/51.0.0.post20201207 requests-toolbelt/0.9.1 tqdm/4.55.1 CPython/3.8.5
|
Release files / tascCODA-0.1.3-py3-none-any.whl
| Download URL | tascCODA-0.1.3-py3-none-any.whl |
|---|---|
| Size | 20.4 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
1b1b908e65f247c5d5264bbcf5a00af744180473caa8d8ae40720e11d42e2238
|
|
BLAKE2b-256 checksum How to use checksums |
228c0151cd4a64a4b1a944ca3b2d31b3d0dd9cdde23ff24ea5a2ceb608040ddc
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.3.0 pkginfo/1.6.1 requests/2.25.1 setuptools/51.0.0.post20201207 requests-toolbelt/0.9.1 tqdm/4.55.1 CPython/3.8.5
|
Security for tascCODA 0.1.3
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.