Skip to content

Commit 1b18e78

Browse files
authored
Fix installation issues with pyvcf (pip -> conda)
1 parent fb061e7 commit 1b18e78

File tree

1 file changed

+17
-8
lines changed

1 file changed

+17
-8
lines changed

Diff for: README.md

+17-8
Original file line numberDiff line numberDiff line change
@@ -7,14 +7,15 @@ Pangolin can be run on Google Colab, which provides free acess to GPUs and other
77
See below for information on usage and local installation.
88

99
### Installation
10-
* Prerequisites: Python 3.x and conda, which can both be installed using Miniconda: https://docs.conda.io/en/latest/miniconda.html
11-
* Install PyTorch: https://pytorch.org/get-started/locally/
10+
* Prerequisites: Python 3.6 or higher and conda, which can both be installed using Miniconda: https://docs.conda.io/en/latest/miniconda.html
11+
* Install PyTorch: https://pytorch.org/get-started/locally/
1212
* If a supported GPU is available, installation with GPU support is recommended (choose an option under "Compute Platform")
13-
* Install other dependencies:
13+
* Install other dependencies:
1414
```
15-
pip install pyvcf gffutils biopython pandas pyfastx
15+
conda install -c conda-forge pyvcf
16+
pip install gffutils biopython pandas pyfastx
1617
```
17-
* Install Pangolin:
18+
* Install Pangolin:
1819
```
1920
git clone https://github.com/tkzeng/Pangolin.git
2021
cd Pangolin
@@ -31,15 +32,23 @@ See below for information on usage and local installation.
3132

3233
Annotation databases for GENCODE Release 38 (released 5/5/21) can be downloaded from: https://www.dropbox.com/sh/6zo0aegoalvgd9f/AADWN_cGIWpvVN9BYJ37vGmZa?dl=0
3334
* `gencode.v38.annotation.db`: GENCODE gene annotations for GRCh38 for transcripts with the Ensembl_canonical tag
35+
```
36+
# download annotation file
37+
wget https://www.dropbox.com/sh/6zo0aegoalvgd9f/AADOhGYJo8tbUhpscp3wSFj6a/gencode.v38.annotation.db
38+
```
3439
* `gencode.v38lift37.annotation.db`: GENCODE gene annotations for GRCh38 (lifted to GRCh37) for transcripts with the Ensembl_canonical, appris_principal, appris_candidate, or appris_candidate_longest tags
40+
```
41+
# download annotation file
42+
wget https://www.dropbox.com/sh/6zo0aegoalvgd9f/AAA9Q90Pi1UqSzX99R_NM803a/gencode.v38lift37.annotation.db
43+
```
3544
36-
2. Run Pangolin on a VCF or CSV file containing a list of variants. Under default settings, the maximum increase and decrease in score within 50 bases of the variant, along with their positions, will be reported. Format in the output file: `gene|pos:largest_increase|pos:largest_decrease|`
45+
2. Run Pangolin on a VCF or CSV file containing a list of variants. Under default settings, the maximum increase and decrease in score within 50 bases of the variant, along with their positions, will be reported. Format in the output file: `gene|pos:largest_increase|pos:largest_decrease|`
3746
* Only substitutions and simple insertions/deletions (either the REF or ALT field is a single base) are currently supported.
3847
* Variants are skipped if: they are not contained in a gene, defined by the annotation file; are within 5000 bases of the chromosome ends; are deletions larger than twice the input parameter -d; or do not match sequences from the reference FASTA file.
39-
48+
4049
Example usage:
4150
```
42-
pangolin examples/brca.vcf GRCh37.primary_assembly.genome.fa.gz gencode.v38lift37.annotation.Ensembl_canonical.db brca_pangolin
51+
pangolin examples/brca.vcf GRCh37.primary_assembly.genome.fa.gz gencode.v38lift37.annotation.db brca_pangolin
4352
```
4453
See full options below:
4554
```

0 commit comments

Comments
 (0)