1
- # COVID -MVP
1
+ # VIRUS -MVP
2
2
3
- SARS-CoV-2 lineages and variants pose high risk to global public health.
3
+ Viral lineages and variants pose high risk to global public health.
4
4
5
- COVID -MVP is a heatmap-centric visualization web application that encodes
6
- mutational information across multiple SARS-CoV-2 lineages and variants. The
7
- data visualized by COVID -MVP is generated by two external projects:
5
+ VIRUS -MVP is a heatmap-centric visualization web application that encodes
6
+ mutational information across multiple groups, including SARS-CoV-2 lineages.
7
+ The data visualized by VIRUS -MVP is generated by two external projects:
8
8
9
9
* [ nf-ncov-voc] [ nf-ncov-voc ]
10
10
* [ Pokay] [ pokay ]
11
11
12
- You can find a deployed version of this application (without user upload
13
- functionality) at [ https://covidmvp.cidgoh.ca/ ] [ deployed ] .
14
-
15
- [ deployed ] : https://covidmvp.cidgoh.ca/
12
+ You can find deployed versions of this application (without user upload
13
+ functionality) at https://virusmvp.org/ .
16
14
17
15
![ app_interface]
18
16
19
17
[ app_interface ] : screenshots/app_interface.png
20
18
21
19
## Installation
22
20
23
- ### _ 0. (For users that plan to upload their own data)_ [ Install Nextflow] [ nf ]
21
+ ### _ 0. (If uploading your own data)_ Install [ Nextflow] [ nf ] & [ Conda ] [ conda ] .
24
22
25
23
[ nf ] : https://www.nextflow.io/docs/latest/getstarted.html
24
+ [ conda ] : https://conda.io/projects/conda/en/latest/user-guide/install/
26
25
27
26
### 1. Clone the repository and its submodules
28
27
29
- ` $ git clone git@github.com:cidgoh/COVID -MVP.git --recurse-submodules `
28
+ ` $ git clone git@github.com:cidgoh/VIRUS -MVP.git --recurse-submodules `
30
29
31
30
### 2. Create a virtual environment
32
31
33
- We use [ Conda] [ conda ] , but you can use [ venv] [ venv ] . We
34
- recommend using Python 3.9 in your virtual environment. Older Python versions
35
- may break the application.
36
-
37
- [ conda ] : https://docs.conda.io/en/latest/
38
- [ venv ] : https://docs.python.org/3/library/venv.html
32
+ We use [ Conda] ( https://docs.conda.io/en/latest/ ) , but you can use
33
+ [ venv] ( https://docs.python.org/3/library/venv.html ) .
39
34
40
- ` $ conda create --name=COVID -MVP python=3.9 `
35
+ ` $ conda create --name=VIRUS -MVP `
41
36
42
37
### 3. Activate the environment
43
38
44
- ` $ conda activate COVID -MVP `
39
+ ` $ conda activate VIRUS -MVP `
45
40
46
41
### 4. Install requirements
47
42
48
- ` (COVID -MVP) $ pip install -r requirements.txt `
43
+ ` (VIRUS -MVP) $ pip install -r requirements.txt `
49
44
50
45
### 5. Run the application
51
46
52
47
If you do not run the application from the root directory,
53
48
some of the JavaScript assets will not be compiled.
54
49
55
- ` (COVID -MVP) $ python app.py `
50
+ ` (VIRUS -MVP) $ python app.py `
56
51
57
52
Go to http://0.0.0.0:8050/ .
58
53
@@ -69,17 +64,15 @@ heatmap view.
69
64
70
65
### Heatmap view
71
66
72
- The left axis encodes SARS-CoV-2 lineages. Lineages belonging to VOC are in
67
+ The left axis encodes viral lineages. Lineages belonging to VOC are in
73
68
** bold** , and lineages belonging to VOI are in _ italics_ . Actively circulating
74
69
lineages are denoted with ⚠️.
75
70
76
71
The right axis encodes the number of genomic sequences analyzed for each
77
72
lineage.
78
73
79
74
The top axis encodes the nucleotide position of lineage mutations, with respect
80
- to the [ reference SARS-CoV-2 genome] [ wuhan ] from Wuhan.
81
-
82
- [ wuhan ] : https://www.ncbi.nlm.nih.gov/nuccore/NC_045512.2
75
+ to the reference genome.
83
76
84
77
The bottom axis encodes the amino acid position of lineage mutations, in the
85
78
following format:
@@ -138,14 +131,16 @@ corresponding to non-clade defining mutations.
138
131
139
132
#### Uploading data
140
133
141
- The upload button ![ upload_btn] allows you to upload your own SARs-CoV-2 genomic
142
- data in ` FASTA ` or ` VCF ` format. You can find examples of files users can
143
- upload in [ test_data/] [ 3 ] .
134
+ The upload button ![ upload_btn] allows you to upload your own genomic data in
135
+ ` FASTA ` or ` VCF ` format. You can find examples of files users can upload in
136
+ [ test_data/] [ 3 ] .
144
137
145
138
[ upload_btn ] : screenshots/upload_btn.png
146
139
[ 3 ] : test_data/
147
140
148
- _ You must have Nextflow installed to upload files._
141
+ _ You must have Nextflow and Conda installed to upload files._
142
+
143
+ _ Your first upload will take a while. Subsequent uploads will be faster._
149
144
150
145
#### Downloading data
151
146
@@ -158,11 +153,11 @@ examples of these reports in [surveillance_reports/][4].
158
153
159
154
## [ nf-ncov-voc] [ nf-ncov-voc ]
160
155
161
- Nextflow-wrapped workflow for SARS-CoV-2 variant calling.
156
+ Nextflow-wrapped workflow for variant calling.
162
157
163
158
## [ pokay] [ pokay ]
164
159
165
- Repository for SARS-CoV-2 mutation functions.
160
+ Repository for mutation functions.
166
161
167
162
[ nf-ncov-voc ] : https://github.com/cidgoh/nf-ncov-voc/
168
163
[ pokay ] : https://github.com/nodrogluap/pokay/
0 commit comments