Skip to content

Commit c6cee4c

Browse files
authored
Update README.md
1 parent 1154ade commit c6cee4c

File tree

1 file changed

+42
-43
lines changed

1 file changed

+42
-43
lines changed

README.md

Lines changed: 42 additions & 43 deletions
Original file line numberDiff line numberDiff line change
@@ -27,18 +27,58 @@ Some other things to know:
2727

2828
## Table of Contents
2929

30+
- [Installation](#installation)
31+
- [Dependencies](#dependencies)
3032
- [Examples](#examples)
3133
* [Basic Usage](#basic-usage)
3234
* [Plotting wild-type protein and exon structure](#plotting-wild-type-protein-and-exon-structure)
3335
* [Canonical gene isoforms](#canonical-gene-isoforms)
3436
* [Input from fusion-finding algorithms](#input-from-fusion-finding-algorithms)
3537
* [Graphical parameters](#graphical-parameters)
36-
- [Installation](#installation)
37-
- [Dependencies](#dependencies)
3838
- [Troubleshooting](#troubleshooting)
3939
- [License](#license)
4040
- [Citing AGFusion](#citing-agfusion)
4141

42+
# Installation
43+
44+
**Step 1:** Install AGFusion.
45+
46+
```
47+
pip install agfusion
48+
```
49+
50+
**Step 2:** Download your desired pyensembl reference genome database. For example:
51+
52+
```
53+
For GRCh38/hg38:
54+
pyensembl install --species homo_sapiens --release 95
55+
56+
For GRCh37/hg19:
57+
pyensembl install --species homo_sapiens --release 75
58+
59+
For GRCm38/mm10:
60+
pyensembl install --species mus_musculus --release 87
61+
```
62+
63+
**Step 3:** Finally, download your desired AGFusion database.
64+
65+
```
66+
For GRCh38/hg38:
67+
agfusion download -g hg38
68+
69+
For GRCh37/hg19:
70+
agfusion download -g hg19
71+
72+
For GRCm38/mm10:
73+
agfusion download -g mm10
74+
```
75+
76+
You can view all supported species and ensembl releases with ```agfusion download -a```.
77+
78+
# Dependencies
79+
80+
* Python 3.7 or higher
81+
* Python package dependencies are listed in [requirements.txt](https://github.com/murphycj/AGFusion/blob/master/requirements.txt).
4282

4383
## Examples
4484

@@ -175,47 +215,6 @@ agfusion annotate \
175215
![alt tag](https://github.com/murphycj/AGFusion/blob/master/doc/ENSMUST00000064477-ENSMUST00000002487-rescale.png)
176216
![alt tag](https://github.com/murphycj/AGFusion/blob/master/doc/ENSMUST00000122054-ENSMUST00000070330-rescale.png)
177217

178-
# Installation
179-
180-
First you need to install pyensembl (and the other dependencies listed at the bottom) and download the reference genome you will use by running one of the following.
181-
182-
```
183-
For GRCh38/hg38:
184-
pyensembl install --species homo_sapiens --release 95
185-
186-
For GRCh37/hg19:
187-
pyensembl install --species homo_sapiens --release 75
188-
189-
For GRCm38/mm10:
190-
pyensembl install --species mus_musculus --release 87
191-
```
192-
193-
Then you can install AGFusion:
194-
195-
```
196-
pip install agfusion
197-
```
198-
199-
Finally, download the AGFusion database for your reference genome (downloaded from [here](https://github.com/murphycj/AGFusionDB)).
200-
201-
```
202-
For GRCh38/hg38:
203-
agfusion download -g hg38
204-
205-
For GRCh37/hg19:
206-
agfusion download -g hg19
207-
208-
For GRCm38/mm10:
209-
agfusion download -g mm10
210-
```
211-
212-
You can view all supported species and ensembl releases with ```agfusion download -a```. Due to limitations in pyensembl, the maximum supported Ensembl release is 87.
213-
214-
# Dependencies
215-
216-
* Python 3.7 or higher
217-
* Python package dependencies are listed in [requirements.txt](https://github.com/murphycj/AGFusion/blob/master/requirements.txt).
218-
219218
# Troubleshooting
220219

221220
**(1) Problem:** I get a warning message like the following:

0 commit comments

Comments
 (0)