You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+3-3Lines changed: 3 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -3,15 +3,15 @@
3
3
MALVIRUS is a fast and accurate tool for genotyping haploid individuals that does not require to assemble the read nor mapping them to a reference genome.
4
4
It is tailored to work with virological data and can genotype an individual directly from sequencing data in minutes.
5
5
6
-
MALVIRUS is divided into two logically distinct steps: the creation of the index representing the knowledge base of the species under investigation and the genotype imputation.
6
+
MALVIRUS is divided into two logically distinct steps: the creation of a variant catalog from a set of assemblies and the genotype calling.
7
7
The first step is based on mafft [[1]](#mafft7) and snp-sites [[2]](#snp-sites), whereas the second step is based on KMC [[3]](#kmc) and MALVA [[4]](#malva).
8
8
9
-
The index can be built once and reused for genotyping multiple individuals.
9
+
The variant catalog can be built once and reused for genotyping multiple individuals.
10
10
11
11
Please see the [help directory](./help) for additional details.
12
12
13
13
MALVIRUS is distributed as a Docker image and is publicly available on [GitHub](https://github.com/AlgoLab/MALVIRUS) and [Docker Hub](https://hub.docker.com/r/algolab/malvirus) under the terms of the GNU General Public License version 3 or later.
14
-
The service was tested under Ubuntu GNU/Linux version 18.04 and requires docker installed on the system.
14
+
MALVIRUS was mainly developed and tested under Ubuntu GNU/Linux version 18.04 but works wherever Docker is available.
Copy file name to clipboardExpand all lines: help/README.md
+3-3Lines changed: 3 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -3,10 +3,10 @@
3
3
MALVIRUS is a fast and accurate tool for genotyping haploid individuals that does not require to assemble the read nor mapping them to a reference genome.
4
4
It is tailored to work with virological data and can genotype an individual directly from sequencing data in minutes.
5
5
6
-
MALVIRUS is divided into two logically distinct steps: the creation of the index representing the knowledge base of the species under investigation and the genotype imputation.
6
+
MALVIRUS is divided into two logically distinct steps: the creation of a variant catalog from a set of assemblies and the genotype calling.
7
7
The first step is based on mafft [[1]](#mafft7) and snp-sites [[2]](#snp-sites), whereas the second step is based on KMC [[3]](#kmc) and MALVA [[4]](#malva).
8
8
9
-
The index can be built once and reused for genotyping multiple individuals.
9
+
The variant catalog can be built once and reused for genotyping multiple individuals.
10
10
11
11
Please see the following documents for additional details:
12
12
@@ -15,7 +15,7 @@ Please see the following documents for additional details:
15
15
*[Tutorial](./TUTORIAL.md)
16
16
17
17
MALVIRUS is distributed as a Docker image and is publicly available on [GitHub](https://github.com/AlgoLab/MALVIRUS) and [Docker Hub](https://hub.docker.com/r/algolab/malvirus) under the terms of the GNU General Public License version 3 or later.
18
-
The service was tested under Ubuntu GNU/Linux version 18.04 and requires docker installed on the system.
18
+
MALVIRUS was mainly developed and tested under Ubuntu GNU/Linux version 18.04 but works wherever Docker is available.
Copy file name to clipboardExpand all lines: help/USAGE.md
+9-10Lines changed: 9 additions & 10 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,17 +1,16 @@
1
1
# Usage
2
-
1.[Creating the index](#creating-the-index)
3
-
-[Building the index from a population of genomes](#building-the-index-from-a-population-of-genomes)
4
-
-[Uploading the index using a precomputed VCF](#uploading-the-index-using-a-precomputed-VCF)
5
-
2.[Genotype imputation](#genotype-imputation)
2
+
1.[Creating the variant catalog](#creating-the-variant-catalog)
3
+
-[Building the catalog from a population of genomes](#building-the-catalog-from-a-population-of-genomes)
4
+
-[Uploading the catalog using a precomputed VCF](#uploading-the-catalog-using-a-precomputed-vcf)
5
+
2.[Genotype calling](#genotype-calling)
6
6
3.[Retrieving the results](#retrieving-the-results)
7
-
4.[References](#references)
8
7
9
-
## Creating the index
8
+
## Creating the variant catalog
10
9
11
10
There are two main approaches to build an index of known variants.
12
11
The first one is to build it from a reference genome and a set of genomic sequences of the same specie (i.e., a set of _assemblies_), whereas the second is to upload a reference genome and a VCF file.
13
12
14
-
### Building the index from a population of genomes
13
+
### Building the catalog from a population of genomes
15
14
16
15
We will first show how to build the index from a reference genome and a set of genomic sequences.
17
16
Note that, the reference genome must be in FASTA format, whereas the set of genomic sequences must be in multi-FASTA format.
@@ -33,7 +32,7 @@ Note that for datasets composed by thousands of viral assemblies this step might
33
32
Clicking again on the _Reference VCFs_ tab at the top will present the list of indexes and the status of the job used to build it.
34
33
Once the status is <spanstyle="color:#237804">Completed</span> the index can be used to call variants.
35
34
36
-
### Uploading the index using a precomputed VCF
35
+
### Uploading the catalog using a precomputed VCF
37
36
38
37
If the set of known variants is already available as a VCF, you can avoid computing the index and upload the reference genome and the VCF instead.
39
38
@@ -47,7 +46,7 @@ If you upload this information, then variant calls that will use this index will
47
46
48
47
Finally, click on the _Submit_ button on the bottom to upload and create the new index.
49
48
50
-
## Genotype imputation
49
+
## Genotype calling
51
50
52
51
The main goal of MALVIRUS is to genotype an individual directly from a sequencing dataset.
53
52
@@ -58,7 +57,7 @@ You will be presented with a form that you have to fill in with the required dat
58
57
Set the _Alias_ and _Description_ fields to something meaningful, remember _Alias_ will be the name of the job you will submit.
59
58
Then, upload the sequencing data in either FASTA of FASTQ format in the _Sample sequences_ field and chose an index to use while genotyping the data in the _Reference VCF_ field.
60
59
61
-
If no reference VCF is available in the drop-down menu of the _Reference VCF_ field, you probably did not create an index yet; head to the [Creating the index](#creating-the-index) section of this document and follow the instructions.
60
+
If no reference VCF is available, MALVIRUS asks you to first create a variant catalog; head to the [Creating the variant catalog](#creating-the-variant-catalog) section of this document and follow the instructions.
62
61
63
62
After uploading the sample and selecting the index you are able to submit the job by clicking the _Submit_ button.
0 commit comments