Skip to content

Commit df583c1

Browse files
committed
docs: update readme
1 parent 1bace66 commit df583c1

File tree

1 file changed

+11
-3
lines changed

1 file changed

+11
-3
lines changed

README.md

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ paper: "[A versatile information retrieval framework for evaluating profile stre
66
## Getting started
77

88
### System requirements
9-
copairs supports Python 3.9+ and should work with all modern operating systems (tested with MacOS 13.5, Ubuntu 18.04).
9+
This repository supports Python 3.9+ and should work with all modern operating systems (tested with MacOS 13.5, Ubuntu 18.04).
1010

1111
### Dependencies
1212
This code depends on widely used Python packages:
@@ -19,7 +19,8 @@ This code depends on widely used Python packages:
1919
* umap-learn
2020
* scikit-learn
2121

22-
It also uses [pycytominer](https://github.com/alxndrkalinin/pycytominer/tree/fix-ops-custom-features) for profiling data preprocessing and [copairs](https://github.com/cytomining/copairs/tree/v0.4.2) for profile grouping and mAP calculations.
22+
It also uses [pycytominer](https://github.com/alxndrkalinin/pycytominer/tree/fix-ops-custom-features) for profiling data preprocessing and [copairs](https://github.com/cytomining/copairs/tree/v0.4.3) for profile grouping and mAP calculations.
23+
2324

2425
### Installation
2526

@@ -33,6 +34,13 @@ conda activate map_eval
3334
pip install .
3435
```
3536

37+
#### R installation
38+
Preprocessing of [Perturb-seq data](./experiments/6_perturbseq/) requires creating a separate R environment:
39+
40+
```bash
41+
conda env create -f perturbseq_processing_environment.yml
42+
```
43+
3644
## Contents
3745

3846
Results are organized per dataset in the [experiments](./experiments/) subdirectory.
@@ -46,7 +54,7 @@ Each experiment directory includes brief description of the dataset and scripts
4654
3. [cpg0004 data](./experiments/3_cpg0004/) (Figures S7A, S7C)
4755
4. [cpg0016orf data](./experiments/4_cpg0016orf/) (Figures S7B, S7D)
4856
5. [nELISA data](./experiments/5_nelisa/) (Figures 4A-B)
49-
6. [PerturbSeq data](./experiments/6_perturbseq/) (Figures 4C-D, S5A-B, S8)
57+
6. [Perturb-seq data](./experiments/6_perturbseq/) (Figures 4C-D, S5A-B, S8)
5058
7. [Mitocheck data](./experiments/7_mitocheck/) (Figure 5C-D, S9-10)
5159

5260
## Citation

0 commit comments

Comments
 (0)