Skip to content

Commit 83c3428

Browse files
uniquegninsch3000
andauthored
docs: minor fixes (#88)
Co-authored-by: Christina Herrmann <christina.herrmann@unibas.ch>
1 parent 32c9156 commit 83c3428

File tree

3 files changed

+10
-7
lines changed

3 files changed

+10
-7
lines changed

README.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -17,10 +17,11 @@ where to start? **Easy - _ZARP 'em!_**
1717
- Barry left you some samples to analyze and then went on vacation, again? **No
1818
problem, _ZARP 'em!_**
1919

20-
ZARP-cli uses the HTSinfer package to infer missing metadata and then runs the
21-
[ZARP RNA-Seq analysis pipeline][zarp] on your samples. Impress your colleagues
22-
with your sudden productivity boost. Or better yet, use the time saved to go on
23-
that camping trip with Barry. Just make sure to guard your secret! :wink:
20+
ZARP-cli uses the [HTSinfer][htsinfer] package to infer missing metadata and
21+
then runs the [ZARP RNA-Seq analysis pipeline][zarp] on your samples. Impress
22+
your colleagueswith your sudden productivity boost. Or better yet, use the time
23+
saved to go on that camping trip with Barry. Just make sure to guard your
24+
secret! :wink:
2425

2526
## Basic usage
2627

@@ -112,6 +113,7 @@ by [email][contact].
112113
[badge-url-docs]: <https://zavolanlab.github.io/zarp-cli>
113114
[badge-url-github-tag]: <https://github.com/zavolanlab/zarp-cli/releases>
114115
[badge-url-license]: <http://www.apache.org/licenses/LICENSE-2.0>
116+
[htsinfer]: <https://github.com/zavolanlab/htsinfer>
115117
[issue-tracker]: <https://github.com/zavolanlab/zarp-cli/issues>
116118
[mamba]: <https://github.com/mamba-org/mamba>
117119
[semver]: <https://semver.org/>

docs/guides/usage.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ Available command-line parameters are grouped into the following sections:
4747
| **Run modes** | These parameters execute _ZARP-cli_ in special modes, e.g., for initialization or to display the help screen |
4848
| **Sample-specific** | These parameters modify globally set metadata for all samples of a run, unless overridden inside provided sample tables |
4949
| **Run-specific** | These parameters modify the behavior of _ZARP-cli_ or set metadata to describe runs |
50-
| **User-specific** | These parameters that will be included in the _ZARP_ report, if available |
50+
| **User-specific** | These parameters will be included in the _ZARP_ report, if available |
5151

5252
A complete listing of all available CLI options can easily be printed to the
5353
screen, together with detailed descriptions, with the following command and

zarp/config/args.py

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -405,8 +405,9 @@ def _set_run_arguments(
405405
default=None,
406406
type=str,
407407
help=(
408-
"run identifier; if not provided a random string will be"
409-
" generated"
408+
"whether to trigger a full ZARP-cli run, "
409+
"a dry run (external tools are not run, for testing),"
410+
"or prepare a ZARP run (input data creation only)"
410411
),
411412
)
412413
argument_group.add_argument(

0 commit comments

Comments
 (0)