Skip to content

Commit

Permalink
Updating docs and bump up minor version for new feat
Browse files Browse the repository at this point in the history
  • Loading branch information
skchronicles committed May 31, 2024
1 parent 7dc7d80 commit 4d30e18
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 1 deletion.
2 changes: 1 addition & 1 deletion VERSION
Original file line number Diff line number Diff line change
@@ -1 +1 @@
0.5.1
0.6.0
9 changes: 9 additions & 0 deletions docs/usage/run.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ $ nanite run [--help] \
[--resource-bundle RESOURCE_BUNDLE] [--use-conda] \
[--conda-env-name CONDA_ENV_NAME] \
[--quality-filter QUALITY_FILTER] \
[--assemble-reads] \
--input INPUT [INPUT ...] \
--output OUTPUT
```
Expand Down Expand Up @@ -60,6 +61,14 @@ Each of the following arguments are optional, and do not need to be provided.
>
> ***Example:*** `--quality-filter 10`
`--assemble-reads`
> **Assemble reads.**
> *type: boolean flag*
>
> 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.
>
> ***Example:*** `--assemble-reads`
### 2.3 Orchestration options

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

0 comments on commit 4d30e18

Please sign in to comment.