-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
2 changed files
with
36 additions
and
4 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,6 +1,36 @@ | ||
# Examples | ||
|
||
!!! warning "Under construction" | ||
This section provides a growing collection of examples that demonstrate how to | ||
use _ZARP-cli_ in various scenarios. | ||
|
||
This section is under preparation and will list a number of real-world, | ||
fully functional examples. Please stay tuned. | ||
!!! info "Prerequisites" | ||
|
||
The examples below assume that you have already [installed](./installation.md) and [initialized](./initialization.md) _ZARP-cli. | ||
|
||
## Process samples deposited to SRA | ||
|
||
Let's have ZARP-cli fetch two samples from SRA, infer all necessary metadata, | ||
fetch the corresponding genome annotations and start a _ZARP_ workflow run on | ||
them: | ||
|
||
```sh | ||
zarp SRR23590181 SRR23529108 | ||
``` | ||
|
||
??? tip "I want to verify the inferred metadata first!" | ||
|
||
Set the `--execution-mode` parameter to `PREPARE_RUN` to run _ZARP-cli_ up | ||
until the point of the actual _ZARP_ workflow execution: | ||
|
||
```sh | ||
zarp --execution-mode=PREPARE_RUN SRR23590181 SRR23529108 | ||
``` | ||
|
||
!!! info "More please!" | ||
|
||
You will find a description of more elaborate use cases in the [ZARP | ||
publication](https://doi.org/10.12688/f1000research.149237.1) and the | ||
accompanying [supplementary materials][zarp-supplementary], published on | ||
[Zenodo][zenodo]. The latter include detailed instructions, all necessary | ||
input files and a selection of reference output files to validate your runs | ||
against. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters