Skip to content

Commit 9d4ee17

Browse files
committed
Merge branch 'development' into no_upload_master
2 parents 2326414 + 6059204 commit 9d4ee17

File tree

1,003 files changed

+6849
-283936
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

1,003 files changed

+6849
-283936
lines changed

.github/workflows/ci.yml

Lines changed: 0 additions & 28 deletions
This file was deleted.

.github/workflows/submodule_update.yml

Lines changed: 0 additions & 30 deletions
This file was deleted.

README.md

Lines changed: 26 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -1,58 +1,53 @@
1-
# COVID-MVP
1+
# VIRUS-MVP
22

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.
44

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:
88

99
* [nf-ncov-voc][nf-ncov-voc]
1010
* [Pokay][pokay]
1111

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/.
1614

1715
![app_interface]
1816

1917
[app_interface]: screenshots/app_interface.png
2018

2119
## Installation
2220

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].
2422

2523
[nf]: https://www.nextflow.io/docs/latest/getstarted.html
24+
[conda]: https://conda.io/projects/conda/en/latest/user-guide/install/
2625

2726
### 1. Clone the repository and its submodules
2827

29-
`$ git clone git@github.com:cidgoh/COVID-MVP.git --recurse-submodules`
28+
`$ git clone git@github.com:cidgoh/VIRUS-MVP.git --recurse-submodules`
3029

3130
### 2. Create a virtual environment
3231

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).
3934

40-
`$ conda create --name=COVID-MVP python=3.9`
35+
`$ conda create --name=VIRUS-MVP`
4136

4237
### 3. Activate the environment
4338

44-
`$ conda activate COVID-MVP`
39+
`$ conda activate VIRUS-MVP`
4540

4641
### 4. Install requirements
4742

48-
`(COVID-MVP) $ pip install -r requirements.txt`
43+
`(VIRUS-MVP) $ pip install -r requirements.txt`
4944

5045
### 5. Run the application
5146

5247
If you do not run the application from the root directory,
5348
some of the JavaScript assets will not be compiled.
5449

55-
`(COVID-MVP) $ python app.py`
50+
`(VIRUS-MVP) $ python app.py`
5651

5752
Go to http://0.0.0.0:8050/.
5853

@@ -69,17 +64,15 @@ heatmap view.
6964

7065
### Heatmap view
7166

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
7368
**bold**, and lineages belonging to VOI are in _italics_. Actively circulating
7469
lineages are denoted with ⚠️.
7570

7671
The right axis encodes the number of genomic sequences analyzed for each
7772
lineage.
7873

7974
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.
8376

8477
The bottom axis encodes the amino acid position of lineage mutations, in the
8578
following format:
@@ -138,14 +131,16 @@ corresponding to non-clade defining mutations.
138131

139132
#### Uploading data
140133

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].
144137

145138
[upload_btn]: screenshots/upload_btn.png
146139
[3]: test_data/
147140

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._
149144

150145
#### Downloading data
151146

@@ -158,11 +153,11 @@ examples of these reports in [surveillance_reports/][4].
158153

159154
## [nf-ncov-voc][nf-ncov-voc]
160155

161-
Nextflow-wrapped workflow for SARS-CoV-2 variant calling.
156+
Nextflow-wrapped workflow for variant calling.
162157

163158
## [pokay][pokay]
164159

165-
Repository for SARS-CoV-2 mutation functions.
160+
Repository for mutation functions.
166161

167162
[nf-ncov-voc]: https://github.com/cidgoh/nf-ncov-voc/
168163
[pokay]: https://github.com/nodrogluap/pokay/

app.py

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -40,8 +40,8 @@
4040
# contains the visualization that is deployed by this file, when
4141
# ``app`` is served.
4242
app = dash.Dash(
43-
name="COVID-MVP",
44-
title="COVID-MVP",
43+
name="VIRUS-MVP",
44+
title="VIRUS-MVP",
4545
assets_folder=ASSETS_DIR,
4646
# We bring in jQuery for some of the JavaScript
4747
# callbacks.
@@ -813,9 +813,6 @@ def update_heatmap_sample_size_axis_fig(_, get_data_args, last_data_mtime):
813813
def update_heatmap_gene_bar_fig(_, get_data_args, last_data_mtime):
814814
"""Update heatmap gene bar fig.
815815
816-
We need to update style because width might have changed due to
817-
added nt positions in data.
818-
819816
:param _: Heatmap cells fig updated
820817
:param get_data_args: Args for ``get_data``
821818
:type get_data_args: dict

0 commit comments

Comments
 (0)