Skip to content

Commit a9b7720

Browse files
committed
HELP: fix USAGE and README terminology
1 parent f3c8655 commit a9b7720

File tree

3 files changed

+15
-16
lines changed

3 files changed

+15
-16
lines changed

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,15 +3,15 @@
33
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.
44
It is tailored to work with virological data and can genotype an individual directly from sequencing data in minutes.
55

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.
77
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).
88

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

1111
Please see the [help directory](./help) for additional details.
1212

1313
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.
1515

1616
# References
1717

help/README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,10 +3,10 @@
33
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.
44
It is tailored to work with virological data and can genotype an individual directly from sequencing data in minutes.
55

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.
77
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).
88

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

1111
Please see the following documents for additional details:
1212

@@ -15,7 +15,7 @@ Please see the following documents for additional details:
1515
* [Tutorial](./TUTORIAL.md)
1616

1717
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.
1919

2020
# References
2121

help/USAGE.md

Lines changed: 9 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,16 @@
11
# 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)
66
3. [Retrieving the results](#retrieving-the-results)
7-
4. [References](#references)
87

9-
## Creating the index
8+
## Creating the variant catalog
109

1110
There are two main approaches to build an index of known variants.
1211
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.
1312

14-
### Building the index from a population of genomes
13+
### Building the catalog from a population of genomes
1514

1615
We will first show how to build the index from a reference genome and a set of genomic sequences.
1716
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
3332
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.
3433
Once the status is <span style="color:#237804">Completed</span> the index can be used to call variants.
3534

36-
### Uploading the index using a precomputed VCF
35+
### Uploading the catalog using a precomputed VCF
3736

3837
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.
3938

@@ -47,7 +46,7 @@ If you upload this information, then variant calls that will use this index will
4746

4847
Finally, click on the _Submit_ button on the bottom to upload and create the new index.
4948

50-
## Genotype imputation
49+
## Genotype calling
5150

5251
The main goal of MALVIRUS is to genotype an individual directly from a sequencing dataset.
5352

@@ -58,7 +57,7 @@ You will be presented with a form that you have to fill in with the required dat
5857
Set the _Alias_ and _Description_ fields to something meaningful, remember _Alias_ will be the name of the job you will submit.
5958
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.
6059

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

6362
After uploading the sample and selecting the index you are able to submit the job by clicking the _Submit_ button.
6463

0 commit comments

Comments
 (0)