Skip to content

Commit 0882322

Browse files
committed
Update README with tip for installing with pipenv
Also satiate my markdown linter.
1 parent 582d1ee commit 0882322

File tree

1 file changed

+16
-6
lines changed

1 file changed

+16
-6
lines changed

README.md

Lines changed: 16 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,30 @@
11
# DoubletDetection
2+
23
[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.2678042.svg)](https://doi.org/10.5281/zenodo.2678042)
34
[![Documentation Status](https://readthedocs.org/projects/doubletdetection/badge/?version=latest)](https://doubletdetection.readthedocs.io/en/latest/?badge=latest)
45

5-
66
DoubletDetection is a Python3 package to detect doublets (technical errors) in single-cell RNA-seq count matrices.
77

8+
## Installing DoubletDetection
89

9-
To install DoubletDetection:
10-
11-
```
10+
```bash
1211
git clone https://github.com/JonathanShor/DoubletDetection.git
1312
cd DoubletDetection
1413
pip3 install .
1514
```
1615

17-
To run basic doublet classification:
16+
If you are using `pipenv` as your virtual environment, it may struggle installing from the setup.py due to our custom Phenograph requirement.
17+
If so, try the following in the cloned repo:
1818

19+
```bash
20+
pipenv run pip3 install .
1921
```
22+
23+
## Running DoubletDetection
24+
25+
To run basic doublet classification:
26+
27+
```Python
2028
import doubletdetection
2129
clf = doubletdetection.BoostClassifier()
2230
# raw_counts is a cells by genes count matrix
@@ -27,6 +35,7 @@ labels = clf.fit(raw_counts).predict()
2735
- `labels` is a 1-dimensional numpy ndarray with the value 1 representing a detected doublet, 0 a singlet, and `np.nan` an ambiguous cell.
2836

2937
The classifier works best when
38+
3039
- There are several cell types present in the data
3140
- It is applied individually to each run in an aggregated count matrix
3241

@@ -35,10 +44,11 @@ In `v2.5` we have added a new experimental clustering method (`scanpy`'s Louvain
3544
See our [jupyter notebook](https://nbviewer.jupyter.org/github/JonathanShor/DoubletDetection/blob/master/tests/notebooks/PBMC_8k_vignette.ipynb) for an example on 8k PBMCs from 10x.
3645

3746
## Obtaining data
38-
Data can be downloaded from the [10x website](https://support.10xgenomics.com/single-cell/datasets).
3947

48+
Data can be downloaded from the [10x website](https://support.10xgenomics.com/single-cell/datasets).
4049

4150
## Citations
51+
4252
bioRxiv submission and journal publication expected in the coming months. Please use the following for now:
4353

4454
Gayoso, Adam, & Shor, Jonathan. (2018, July 17). DoubletDetection (Version v2.4). Zenodo. http://doi.org/10.5281/zenodo.2678042

0 commit comments

Comments
 (0)