Skip to content

Commit d23fd9c

Browse files
author
Alexis Morrissey
committed
Merge branch 'main' of github.com:seqcode/allo into main
2 parents 9cf98b2 + 10ee587 commit d23fd9c

File tree

1 file changed

+25
-16
lines changed

1 file changed

+25
-16
lines changed

README.md

Lines changed: 25 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,27 @@
1-
# Usage
2-
## Installation and dependencies
1+
# Allo
32

4-
Allo is available on PyPI
3+
A multi-mapped read rescue strategy for peak-based gene regulatory analyses.
54

6-
[![PyPI version](https://badge.fury.io/py/bio-allo.svg)](https://badge.fury.io/py/bio-allo)
5+
## Installation
76

8-
Allo was written with the following imported packages. All other packages used are built into Python. Especially concerning Tensorflow, it is recommended to create a conda environment specific to this version as Allo may not function without it:
7+
### Using PyPI and pip
98

10-
joblib 1.1.0
9+
[![PyPI version](https://badge.fury.io/py/bio-allo.svg)](https://badge.fury.io/py/bio-allo)
1110

12-
numpy 1.23.1
11+
```
12+
pip install bio-allo
13+
```
1314

14-
tensorflow 2.11
15+
### Using git clone and pip
1516

16-
pysam 0.20.0
17+
```
18+
git clone https://github.com/seqcode/allo.git
19+
cd allo
20+
pip install -e .
21+
```
1722

18-
## Pre-processing
23+
## Usage
24+
### Pre-processing
1925
Using Allo requires a few pre-processing steps. In most ChIP pipelines, the default behavior of aligners is to assign multi-mapped reads to random locations within their mappings without retaining information on the other locations. Both Bowtie1/2 and BWA can be used for single-end. Unfortunately, BWA cannot be used for paired-end reads prior to Allo due to constraints in how it outputs multi-mapped reads. The following arguments should be used:
2026

2127
*Bowtie1*
@@ -46,7 +52,7 @@ Finally, the output of the aligners must be sorted by read name in order to use
4652
samtools collate -o ALIGNEROUTPUT_SORT.SAM ALIGNEROUTPUT_FILTER.SAM
4753
```
4854

49-
## Running Allo
55+
### Running Allo
5056
The basic command for Allo:
5157
```
5258
allo ALIGNEROUTPUT_SORT.SAM -seq PAIRED_OR_SINGLE -o OUTPUTNAME -m MIXED_OR_NARROW_PEAKS
@@ -55,13 +61,19 @@ Allo also accepts BAM files as input. See other options below..
5561

5662
During each run, Allo will create temporary files as it allocates the data. UM files are reads designated as uniquely mapped (has to be parsed in Bowtie2 or BWA). MM files are unallocated multi-mapped reads. AL files are allocated reads. Checking the size of the AL files during the run will give you an estimate of how many reads have already been allocated at that time.
5763

58-
## Post-processing and tips
64+
Very short test files are supplied to make sure Allo runs to completion on your machine. Imports can take a minute so be patient. Using the paired-end example:
65+
66+
```
67+
allo testRunPE.sam -seq pe
68+
```
69+
70+
### Post-processing and tips
5971
Allo adds a ZA tag to every MMR that is allocated. For reads that are allocated to regions that all contain 0 UMRs (random assignment), a ZZ tag is used instead. This allows users to remove reads that only map to zero UMR regions if they wish. The value within either tag corresponds to the number of places a read/pair mapped to. In order to get only uniquely mapped reads, grep could be used with the -v option to exclude lines with ZA or ZZ tags. On the same note, awk can used to filter reads with a specific number of mapping locations (can also be done with the -max option within Allo). Outside of adding these tags, Allo does not change anything within the read alignment columns for allocated reads.
6072

6173
Tip: It is recommended to run Allo on both the control and target sequencing files in order to balance out background in the samples. We recommend running Allo using the --random argument on the control file. This generally results in higher confidence peaks.
6274

6375

64-
## Options
76+
### Options
6577
| Argument | Options | Explanation |
6678
| ------------- | ------------- | ------------- |
6779
| -o | any string | Output file name |
@@ -79,8 +91,5 @@ Tip: It is recommended to run Allo on both the control and target sequencing fil
7991
| --parser | | Allo utility that produces separate files for unique and multi-mapped reads from a SAM or BAM file. Bowtie2 and BWA will output all alignments that meet the given threshold even if one alignment has the highest score. |
8092

8193

82-
## Test files
83-
Very short test files are supplied to make sure Allo runs to completion on your machine. Imports can take a minute so be patient.
84-
8594
## Contact information
8695
Please contact Alexis Morrissey ([email protected]) with any questions or issues concerning Allo.

0 commit comments

Comments
 (0)