Skip to content

Commit 042478a

Browse files
authored
Update README.md
1 parent 4875ef6 commit 042478a

File tree

1 file changed

+12
-11
lines changed

1 file changed

+12
-11
lines changed

README.md

Lines changed: 12 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -19,19 +19,17 @@ Vclust is an alignment-based tool for fast and accurate calculation of Average N
1919
5. [Usage](#5-usage)
2020
1. [Prefilter](#51-prefilter)
2121
2. [Align](#52-align)
22-
* [Align output](#align-output)
23-
* [Align output filtering](#align-output-filtering)
2422
3. [Cluster](#53-cluster)
25-
* [Cluster output](#cluster-output)
2623
6. [Use cases](#6-use-cases)
2724
1. [Classify viruses into species and genera using the ICTV standards](#61-classify-viruses-into-species-and-genera-using-the-ictv-standards)
2825
2. [Assign viral contigs into vOTUs using the MIUViG standards](#62-assign-viral-contigs-into-votus-using-the-miuvig-standards)
2926
3. [Dereplicate genomes](#63-dereplicate-genomes)
3027
4. [Calculate pairwise similarities between all-versus-all genomes](#64-calculate-pairwise-similarities-between-all-versus-all-genomes)
3128
5. [Process large datasets](#65-process-large-datasets)
32-
7. [Tests](#7-test)
33-
8. [Cite](#8-cite)
34-
9. [License](#9-license)
29+
7. [Limitations](#7-limitations)
30+
8. [Tests](#8-test)
31+
9. [Cite](#9-cite)
32+
10. [License](#10-license)
3533

3634

3735
## 1. Features
@@ -410,21 +408,24 @@ The following commands help reduce RAM usage and hard disk storage, making them
410408
```
411409

412410
> [!NOTE]
413-
> Vclust is efficient for comparing genome sequences of diverse viruses across a wide range of sequence identities. However, its computational performance may decline with very large datasets of highly similar or nearly identical genomes (e.g., tens of thousands from the same species). After prefiltering, numerous sequence pairs may still require alignment and clustering, leading to increased RAM usage and longer run times.
411+
> Please see: 7. Limitations
414412
413+
## 7. Limitations
415414

416-
## 7. Test
415+
Vclust is efficient for comparing genome sequences of diverse viruses across a wide range of sequence identities. However, RAM usage and running time may increase drastically in case of very large datasets of highly similar or nearly identical genomes (e.g., hundreds of thousands from the same species).
416+
417+
## 8. Test
417418

418419
To ensure that Vclust works as expected, you can run tests using [pytest](https://docs.pytest.org/).
419420

420421
```bash
421422
pytest test.py
422423
```
423424

424-
## 8. Cite
425+
## 9. Cite
425426

426-
Zielezinski A, Gudyś A, Barylski J, Siminski K, Rozwalak P, Dutilh BE, Deorowicz S. *Ultrafast and accurate sequence alignment and clustering of viral genomes*. bioRxiv [[doi](https://google.pl)][[pubmed](https://google.pl)].
427+
Zielezinski A, Gudyś A, Barylski J, Siminski K, Rozwalak P, Dutilh BE, Deorowicz S. *Ultrafast and accurate sequence alignment and clustering of viral genomes*. bioRxiv [[doi:10.1101/2024.06.27.601020](https://www.biorxiv.org/content/10.1101/2024.06.27.601020)].
427428

428-
## 9. License
429+
## 10. License
429430

430431
[GNU General Public License, version 3](https://www.gnu.org/licenses/gpl-3.0.html)

0 commit comments

Comments
 (0)