Skip to content

Commit 4d30e18

Browse files
committed
Updating docs and bump up minor version for new feat
1 parent 7dc7d80 commit 4d30e18

File tree

2 files changed

+10
-1
lines changed

2 files changed

+10
-1
lines changed

VERSION

+1-1
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
0.5.1
1+
0.6.0

docs/usage/run.md

+9
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@ $ nanite run [--help] \
1616
[--resource-bundle RESOURCE_BUNDLE] [--use-conda] \
1717
[--conda-env-name CONDA_ENV_NAME] \
1818
[--quality-filter QUALITY_FILTER] \
19+
[--assemble-reads] \
1920
--input INPUT [INPUT ...] \
2021
--output OUTPUT
2122
```
@@ -60,6 +61,14 @@ Each of the following arguments are optional, and do not need to be provided.
6061
>
6162
> ***Example:*** `--quality-filter 10`
6263
64+
`--assemble-reads`
65+
> **Assemble reads.**
66+
> *type: boolean flag*
67+
>
68+
> Assemble reads and recover high-quality viral genomes using Flye and viralFlye. This option will assemble reads using Flye while viralFlye is used to recover viral genomes using Flye's output. By default, this option is not enabled, meaning it will not perform any assemble steps. If you would like to enable assemble reads and recover any pontential viral genomes, please provide this option. It is worth noting that assembling reads has the potential to use a significant amount of computational resources, specifically high memory usage. Internal testing has shown that the pipeline can use up to 8-16GB of memory when assembling reads into repeat graphs. If you provide this option, please ensure that you have enough memory available on the host or local machine before proceeding.
69+
>
70+
> ***Example:*** `--assemble-reads`
71+
6372
### 2.3 Orchestration options
6473

6574
Each of the following arguments are optional, and do not need to be provided.

0 commit comments

Comments
 (0)