Skip to content

Commit 1a01d3b

Browse files
docs: fix docs
1 parent 9359351 commit 1a01d3b

File tree

7 files changed

+288
-429
lines changed

7 files changed

+288
-429
lines changed

docs/api/philogenics.md

Lines changed: 0 additions & 1 deletion
This file was deleted.

docs/basic_usage.md

Lines changed: 30 additions & 125 deletions
Large diffs are not rendered by default.

docs/index.md

Lines changed: 44 additions & 60 deletions
Large diffs are not rendered by default.

docs/templates/help_get-mutations.md

Lines changed: 17 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,21 @@
11
<div class="termy" data-termynal data-ty-macos data-ty-title="shell"><span data-ty="input" data-ty-prompt="$">gramep get-mutations --help</span><span data-ty>
2-
Usage: gramep get-mutations [OPTIONS]
2+
Usage: gramep get-mutations [OPTIONS]
33

4-
Perform k-mers analysis and optionally generate a report.
5-
6-
╭─ Options ─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮
7-
│ * --rpath TEXT 📂 Path to reference sequence. [default: None] [required]
8-
│ * --spath TEXT 📂 Path to sequence. [default: None] [required]
9-
│ * --save-path TEXT 📂 Path to save results. [default: None] [required]
10-
│ * --word -w INTEGER 📏 Word size. [default: None] [required]
11-
│ * --step -s INTEGER ⏭ Step size. [default: None] [required]
12-
│ --apath TEXT 📂 Path to annotation file. [default: None]
13-
│ --snps-max INTEGER ✔ Max number of SNPs allowed. [default: 1]
14-
│ --dictonary -d TEXT 🧬📖 DNA dictionary. [default: DNA]
15-
│ --create-report 📋 Create report. │
16-
│ --save-kmers 💾 Save exclusive k-mers. │
17-
│ --load-exclusive-kmers 📂 Load exclusive k-mers. │
18-
│ --exclusive-kmers TEXT 📂 Path to exclusive k-mers, in .sav format or plain text with one k-mer per line. │
19-
[default: None]
20-
│ --chunk-size INTEGER 📦 Chunk size for loading sequences. [default: 100]
21-
│ --help Show this message and exit. │
22-
╰───────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
4+
Perform k-mers analysis and optionally generate a report.
5+
6+
╭─ Options ─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮
7+
│ * --rpath TEXT 📂 Path to reference sequence. [default: None] [required]
8+
│ * --spath TEXT 📂 Path to sequence. [default: None] [required]
9+
│ * --save-path TEXT 📂 Path to save results. [default: None] [required]
10+
│ * --word -w INTEGER 📏 Word size. [default: None] [required]
11+
│ * --step -s INTEGER ⏭ Step size. [default: None] [required]
12+
│ --apath TEXT 📂 Path to annotation file. [default: None]
13+
│ --snps-max INTEGER ✔ Max number of SNPs allowed. [default: 1]
14+
│ --dictonary -d TEXT 🧬📖 DNA dictionary. [default: DNA]
15+
│ --create-report 📋 Create report. │
16+
│ --chunk-size INTEGER 📦 Chunk size for loading sequences. [default: 100]
17+
│ --help Show this message and exit. │
18+
╰───────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
19+
2320

2421
<br></span></div>

python/gramep/cli.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -219,7 +219,7 @@ def classify(
219219
get_kmers: Annotated[
220220
bool,
221221
Option(
222-
'--should-get-kmers',
222+
'--get-kmers',
223223
help=':straight_ruler: Get only k-mers.',
224224
),
225225
] = False,

python/tests/test_cli_predict_classify.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,7 @@ def test_classify_get_kmers(caplog):
7878
SAVE_PATH,
7979
'--dir-path',
8080
DIR_PATH,
81-
'--should-get-kmers',
81+
'--get-kmers',
8282
'--reference-path',
8383
REF_PATH,
8484
'--dictonary',

0 commit comments

Comments
 (0)