Skip to content

Commit

Permalink
README updates
Browse files Browse the repository at this point in the history
  • Loading branch information
martinaryee committed Apr 25, 2023
1 parent 10d9e7f commit 0d0b144
Showing 1 changed file with 7 additions and 33 deletions.
40 changes: 7 additions & 33 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@

**Note that an updated version of this package, including Python 3 support, is maintained by the Tsai Lab: https://github.com/tsailabSJ/guideseq**

This repo (aryeelab/guideseq) contains experimental features.

------

The guideseq package implements our data preprocessing and analysis pipeline for GUIDE-Seq data. It takes raw sequencing reads (FASTQ) and a parameter manifest file (.yaml) as input and produces a table of annotated off-target sites as output.
Expand Down Expand Up @@ -74,31 +76,15 @@ The individual pipeline steps are:

### Installation<a name="Installation"></a>

The most easiest way to install guideseq pipeline is via conda.

```
conda create -n guideseq -c conda-forge -c bioconda -c anaconda -c tsailabSJ guide_seq
source activate guideseq
guideseq.py -h
## BWA and bedtools are automatically installed
```

Alternatively, you can git clone this repository and install

```
# It's recommended (but not essential) to set up a conda environment to manage dependencies
conda create -n guideseq python=3.8
conda activate guideseq
git clone https://github.com/tsailabSJ/guideseq
git clone --recursive https://github.com/aryeelab/guideseq
cd guideseq
pip install -r requirements.txt
python setup.py install
guideseq.py -h
Expand All @@ -114,26 +100,14 @@ For both bwa and bedtools, make sure you know the path to the respective executa



### Quickstart <a name="Quickstart"></a>
## Quickstart <a name="Quickstart"></a>

```
git clone https://github.com/tsailabSJ/guideseq
cd guideseq/test
guideseq.py all -m test_manifest.yaml
```xml
<appSettings>
... [LEAVE EXISTING LINES UNCHANGED] ...
<add key="CreateFastqForIndexReads" value="1"/>
</appSettings>
```

## Running the Full Analysis Pipeline<a name="full_pipeline"></a>

### Quickstart<a name="quickstart"></a>

To run the full guideseq analysis pipeline, you must first create a manifest YAML file that describes all pipeline inputs. Once you have done so, you can simply run

Expand Down

0 comments on commit 0d0b144

Please sign in to comment.