Skip to content

Commit c871d86

Browse files
committed
Updated README.
1 parent 551fc00 commit c871d86

File tree

1 file changed

+10
-10
lines changed

1 file changed

+10
-10
lines changed

README.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -4,15 +4,15 @@ This repository contains an example dataset for the [Enrich2](https://github.com
44

55
The dataset is a small subset of a deep mutational scan of BRCA1 testing for E3 ubiquitin ligase activity ([Starita *et al.* 2015](http://dx.doi.org/10.1534/genetics.115.175802)). Two replicates each with three time points are included. The FASTQ files contain barcode sequences mapping to single amino acid variants and synonymous variants from the first 30 residues of the mutagenized regions, as well as wild type.
66

7-
To perform the example analysis:
7+
[Enrich2](https://github.com/FowlerLab/Enrich2) is required for analysis. The expected run time is approximately 5 minutes.
88

9-
1. [Download Enrich2](https://github.com/FowlerLab/Enrich2/archive/master.zip) from the [Enrich2 GitHub repository](https://github.com/FowlerLab/Enrich2).
10-
2. Install the Enrich2 software and its dependencies as described in the [Enrich2 documentation](https://readthedocs.org/). We recommend using [Anaconda](https://www.continuum.io/downloads) to manage dependencies.
11-
3. [Download this repository](https://github.com/FowlerLab/Enrich2-Example/archive/master.zip) and unzip it to wherever you like.
12-
4. Using the terminal, navigate to your new "Enrich2-Example-master" directory.
13-
5. To analyze the example dataset:
14-
* If using the Enrich2 command line mode, type: ``enrich_cmd BRCA1_example.json WLS wt``
15-
* If using the Enrich2 graphical user interface, type: ``enrich_gui`` and open "BRCA1_example.json" using the File menu. After the configuration has loaded, click the "Run Analysis" button.
16-
6. Explore the "Enrich2-Example-master/Results/plots" directory to see visualizations from the dataset.
9+
To perform the analysis:
1710

18-
For more information, please refer to the [Enrich2 manuscript](http://biorxiv.org/) or contact [Alan F Rubin](mailto:[email protected]).
11+
1. [Download this repository](https://github.com/FowlerLab/Enrich2-Example/archive/master.zip) and unzip it to wherever you like.
12+
2. Using the terminal, navigate to your new "Enrich2-Example-master" directory. (This step is required for the example because its configuration file contains relative path names.)
13+
3. Run Enrich2:
14+
* To use the command line mode, type: ``enrich_cmd BRCA1_example.json WLS wt``
15+
* To use the graphical user interface, type: ``enrich_gui`` and open "BRCA1_example.json" using the File menu. Once the configuration has loaded, click the "Run Analysis" button.
16+
4. Explore the "Enrich2-Example-master/Results/plots" directory to see visualizations of the dataset.
17+
18+
For more information, please refer to the [Enrich2 manuscript](http://biorxiv.org/) and [Enrich2 documentation](https://readthedocs.org) or contact [Alan F Rubin](mailto:[email protected]).

0 commit comments

Comments
 (0)