Skip to content

Commit 06ac31f

Browse files
committed
Update docs
1 parent 3086474 commit 06ac31f

3 files changed

Lines changed: 24 additions & 4 deletions

File tree

README.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
[![Documentation Status](https://readthedocs.org/projects/causarray/badge/?version=latest)](https://causarray.readthedocs.io/en/latest/?badge=latest)
12
[![PyPI](https://img.shields.io/pypi/v/causarray?label=pypi)](https://pypi.org/project/causarray)
23
[![PyPI-Downloads](https://img.shields.io/pepy/dt/causarray)](https://pepy.tech/project/causarray)
34

@@ -7,21 +8,24 @@
78
Advances in single-cell sequencing and CRISPR technologies have enabled detailed case-control comparisons and experimental perturbations at single-cell resolution. However, uncovering causal relationships in observational genomic data remains challenging due to selection bias and inadequate adjustment for unmeasured confounders, particularly in heterogeneous datasets. To address these challenges, we introduce `causarray` [Du25], a doubly robust causal inference framework for analyzing array-based genomic data at both bulk-cell and single-cell levels. `causarray` integrates a generalized confounder adjustment method to account for unmeasured confounders and employs semiparametric inference with flexible machine learning techniques to ensure robust statistical estimation of treatment effects.
89

910

10-
# Requirements
11+
# Usage
1112

1213

1314
The module can be installed via PyPI:
1415
```cmd
1516
pip install causarray
1617
```
1718

19+
The documentation is available at [causarray.readthedocs.io](https://causarray.readthedocs.io/en/latest/).
20+
21+
1822

1923
# Logs
2024

2125
- [x] (2025-01-30) Python package released on PyPI
2226
- [ ] Documentation
23-
- [ ] R package or wrapper
2427
- [ ] Tutorial
28+
- [ ] R package or wrapper
2529

2630

2731

docs/requirements.txt

Lines changed: 17 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,4 +3,20 @@ sphinx-book-theme
33
numpydoc
44
nbsphinx
55
sphinxcontrib-bibtex
6-
sphinxcontrib-svg2pdfconverter
6+
sphinxcontrib-svg2pdfconverter
7+
8+
9+
h5py
10+
hdf5
11+
joblib
12+
matplotlib
13+
numba
14+
numpy
15+
pandas
16+
scanpy
17+
scikit-learn>=1.6
18+
scipy
19+
seaborn
20+
statsmodels>=0.14
21+
tqdm
22+
sklearn-ensemble-cv>=0.2.4

docs/source/conf.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -108,7 +108,7 @@
108108
# release = '<unknown>'
109109
# -- Options for HTML output ----------------------------------------------
110110

111-
html_title = project + ' v' + release
111+
html_title = project
112112

113113
# -- Options for LaTeX output ---------------------------------------------
114114

0 commit comments

Comments
 (0)