Skip to content

Commit 093be8e

Browse files
authored
ENH Update examples in doc
1 parent 2aa9aec commit 093be8e

File tree

1 file changed

+4
-15
lines changed

1 file changed

+4
-15
lines changed

README.md

Lines changed: 4 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -94,25 +94,25 @@ gmsc-mapper createdb -i examples/target.faa -o examples/ -m mmseqs
9494
- Input is genome contig sequences.
9595

9696
```bash
97-
gmsc-mapper -i examples/example.fa -o examples_output/ --db examples/targetdb.dmnd --habitat examples/ref_habitat.txt --quality examples/ref_quality.txt --taxonomy examples/ref_taxonomy.txt
97+
gmsc-mapper -i ./examples/example.fa -o ./examples_output/ --db ./examples/targetdb.dmnd --habitat ./examples/ref_habitat.npy --habitat-index ./examples/ref_habitat_index.tsv --quality ./examples/ref_quality.txt --taxonomy ./examples/ref_taxonomy.npy --taxonomy-index ./examples/ref_taxonomy_index.tsv
9898
```
9999

100100
- Input is amino acid sequences.
101101

102102
```bash
103-
gmsc-mapper --aa-genes examples/example.faa -o examples_output/ --db examples/targetdb.dmnd --habitat examples/ref_habitat.txt --quality examples/ref_quality.txt --taxonomy examples/ref_taxonomy.txt
103+
gmsc-mapper --aa-genes ./examples/example.faa -o ./examples_output/ --db ./examples/targetdb.dmnd --habitat ./examples/ref_habitat.npy --habitat-index ./examples/ref_habitat_index.tsv --quality ./examples/ref_quality.txt --taxonomy ./examples/ref_taxonomy.npy --taxonomy-index ./examples/ref_taxonomy_index.tsv
104104
```
105105

106106
- Input is nucleotide gene sequences.
107107

108108
```bash
109-
gmsc-mapper --nt-genes examples/example.fna -o examples_output/ --db examples/targetdb.dmnd --habitat examples/ref_habitat.txt --quality examples/ref_quality.txt --taxonomy examples/ref_taxonomy.txt
109+
gmsc-mapper --nt-genes ./examples/example.fna -o ./examples_output/ --db ./examples/targetdb.dmnd --habitat ./examples/ref_habitat.npy --habitat-index ./examples/ref_habitat_index.tsv --quality ./examples/ref_quality.txt --taxonomy ./examples/ref_taxonomy.npy --taxonomy-index ./examples/ref_taxonomy_index.tsv
110110
```
111111

112112
- Check another alignment tool: MMseqs2
113113

114114
```bash
115-
gmsc-mapper -i examples/example.fa -o examples_output/ --db examples/targetdb --habitat examples/ref_habitat.txt --quality examples/ref_quality.txt --taxonomy examples/ref_taxonomy.txt --tool mmseqs
115+
gmsc-mapper -i ./examples/example.fa -o ./examples_output/ --db ./examples/targetdb --habitat ./examples/ref_habitat.npy --habitat-index ./examples/ref_habitat_index.tsv --quality ./examples/ref_quality.txt --taxonomy ./examples/ref_taxonomy.npy --taxonomy-index ./examples/ref_taxonomy_index.tsv --tool mmseqs
116116
```
117117

118118
## Usage
@@ -280,14 +280,6 @@ The output folder will contain
280280

281281
* `--quiet`: Disable alignment console output. (default:False)
282282

283-
* `--db`: Path to the GMSC database file. (default: ../db/targetdb.dmnd)
284-
285-
* `--habitat`: Path to the habitat file. (default: ../db/ref_habitat.tsv.xz)
286-
287-
* `--taxonomy`: Path to the taxonomy file. (default: ../db/ref_taxonomy.tsv.xz)
288-
289-
* `--quality`: Path to the quality file. (default: ../db/ref_quality.tsv.xz)
290-
291283
### Subcommands and Parameters
292284
Subcommands: `gmsc-mapper createdb`
293285

@@ -298,6 +290,3 @@ Subcommands: `gmsc-mapper createdb`
298290
* `-m/--mode`: Alignment tool (Diamond / MMseqs2).
299291

300292
* `--quiet`: Disable alignment console output. (default:False)
301-
302-
## Sensitivity choices considering time and memory usage
303-
To be done

0 commit comments

Comments
 (0)