Skip to content

Commit

Permalink
Readme typos, CLI help formatting
Browse files Browse the repository at this point in the history
  • Loading branch information
bede committed Dec 19, 2024
1 parent 0aa3a52 commit 3ec85a0
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 4 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -163,7 +163,7 @@ INFO: Cleaning…
INFO: Cleaning complete
```
**Long reads (`--stdout`)**
**Long reads (stdout)**
Reads sent to stdout, log sent to stderr
Expand Down Expand Up @@ -235,7 +235,7 @@ INFO: Cleaning…
INFO: Cleaning complete
```
**Short paired reads (`--stdout`)**
**Short paired reads (stdout)**
When using stdout mode with paired input, Hostile sends interleaved paired reads to stdout.
Expand Down
4 changes: 2 additions & 2 deletions src/hostile/cli.py
Original file line number Diff line number Diff line change
Expand Up @@ -38,8 +38,8 @@ def clean(
"""
Remove reads aligning to an index from fastq[.gz] input files or stdin.
:arg fastq1: path to forward fastq[.gz] file (or - for stdin)
:arg fastq2: optional path to reverse fastq[.gz] file (or - for stdin)
:arg fastq1: path to forward fastq[.gz] file or - for stdin
:arg fastq2: optional path to reverse fastq[.gz] file or - for stdin
:arg aligner: alignment algorithm. Defaults to minimap2 (long read) given fastq1 only or bowtie2 (short read)
given fastq1 and fastq2. Override with bowtie2 for single/unpaired short reads
:arg index: name of standard index or path to custom genome (Minimap2) or Bowtie2 index
Expand Down

0 comments on commit 3ec85a0

Please sign in to comment.