Skip to content

Commit f3c8655

Browse files
committed
HELP: fix tutorial terminology
1 parent 8c5dd5e commit f3c8655

File tree

1 file changed

+20
-8
lines changed

1 file changed

+20
-8
lines changed

help/TUTORIAL.md

Lines changed: 20 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,8 @@
33
# Table of contents
44
1. [Introduction](#introduction)
55
2. [Download the data](#download-the-data)
6-
3. [Create an index from the data](#create-an-index-from-the-data)
7-
4. [Genotype imputation](#genotype-imputation)
6+
3. [Create a variant catalog from assemblies](#create-a-variant-catalog-from-assemblies)
7+
4. [Genotype calling](#genotype-calling)
88

99
## Introduction
1010

@@ -24,17 +24,19 @@ git clone https://github.com/algolab/MALVIRUS-tutorial-data
2424

2525
The data include the complete genome of SARS-CoV-2 isolate Wuhan-Hu-1 (accession id: `NC_045512.2`) in file `reference.fasta`, its annotation in file `sars-cov-2.gff`, a set of SARS-CoV-2 complete genomes in file `seqs.fasta`, and an Illumina sequencing dataset of SARS-CoV-2 Malaysia using the ARTIC v1 protocol (SRA accession id: `SRR11514750`) in file `SRR11514750.fastq.gz`.
2626

27-
## Create an index from the data
27+
## Create a variant catalog from assemblies
2828

29-
First we will create the index of known variants induced by the data we downloaded.
29+
First we will create a catalog of known variants induced by the assemblies we downloaded.
3030

3131
Head to the "Reference VCF" tab and click on the "Build a new Reference VCF from genomes" button.
3232

33-
You will be presented with a submission form similar to the following
33+
You will be presented with a submission form similar to the following:
3434

35+
<p align="center">
3536
<a href="vcf_submission_form.png" target="_blank">
3637
<img src="vcf_submission_form.png" width="500px"/>
3738
</a>
39+
</p>
3840

3941
Fill in the information as follows:
4042

@@ -48,24 +50,28 @@ Fill in the information as follows:
4850
Once you filled in all the field with the data, click on the _Submit_ button at the bottom of the page.
4951
You will be redirected to a page reporting the status of the job requested.
5052

53+
<p align="center">
5154
<a href="vcf_submission_report.png" target="_blank">
5255
<img src="vcf_submission_report.png" width="500px"/>
5356
</a>
57+
</p>
5458

5559
To update the status, click on the _Refresh_ button at the bottom of the page.
5660
The status will change from "Pending" to "Running" to "Completed".
5761
Once the status is "Completed", congratulations! You just built your first MALVIRUS index.
5862
Let's now head to genotyping the individual by clicking on the "Variant calls" tab at the top of the page.
5963

60-
## Genotype imputation
64+
## Genotype calling
6165

6266
Head to the "Variant calls" tab and click on the "Perform a new variant call" button.
6367

64-
You will be presented with a submission form similar to the following
68+
You will be presented with a submission form similar to the following:
6569

70+
<p align="center">
6671
<a href="geno_submission_form.png" target="_blank">
6772
<img src="geno_submission_form.png" width="500px"/>
6873
</a>
74+
</p>
6975

7076
Fill in the information as follows:
7177

@@ -83,29 +89,35 @@ Finally, click the _Submit_ button at the bottom of the page.
8389
Similarly to the previous step, you will be redirected to a page reporting the status of the job requested.
8490
To update the status, click on the _Refresh_ button at the bottom of the page.
8591
The status will change from "Pending" to "Running" to "Completed".
86-
Once the status is "Completed", congratulations! You just completed your first genotype imputation using MALVIRUS.
92+
Once the status is "Completed", congratulations! You just completed your first genotype calling using MALVIRUS.
8793

8894
## Accessing the results
8995

9096
To access the results, head back to the "Variant calls" tab where you will find the list of jobs submitted to MALVIRUS.
9197
You will be presented with a table containing a single entry (`SRR11514750`).
9298

99+
<p align="center">
93100
<a href="geno_table.png" target="_blank">
94101
<img src="geno_table.png" width="500px"/>
95102
</a>
103+
</p>
96104

97105
By clicking on the job alias you will be redirected to the job status page.
98106

107+
<p align="center">
99108
<a href="geno_results.png" target="_blank">
100109
<img src="geno_results.png" width="500px"/>
101110
</a>
111+
</p>
102112

103113
In this page you will be able to access the results by clicking on the _Show in tabular form_ button in the "Output files" row.
104114

105115
By default the table in this view will only show the variants genotyped as wild type, by deselecting the "Show only loci with alt. allele" filter you will be able to analyze all the variants genotyped in this run.
106116

117+
<p align="center">
107118
<a href="geno_wild.png" target="_blank">
108119
<img src="geno_wild.png" width="500px"/>
109120
</a>
121+
</p>
110122

111123
Finally, you can download the data both as VCF and in Excel format by clicking the links at the top of the page.

0 commit comments

Comments
 (0)