Skip to content

Commit

Permalink
add sourmash parameters in documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
fmalmeida committed Jul 7, 2024
1 parent 17b82ec commit d6d28b0
Showing 1 changed file with 9 additions and 0 deletions.
9 changes: 9 additions & 0 deletions docs/manual.md
Original file line number Diff line number Diff line change
Expand Up @@ -85,6 +85,15 @@ The use of this parameter sets a default value for input samples. If a sample ha
| :--------------------------------------- | :------- | :------ | :---------- |
| `--resfinder_species` | :material-close: | NA | Resfinder species panel. It activates the resfinder annotation process using the given species panel. Check the available species at [their main page](https://cge.cbs.dtu.dk/services/ResFinder/) and in [their repository page](https://bitbucket.org/genomicepidemiology/resfinder/src/master/#usage). If your species is not available in Resfinder panels, you may use it with the "Other" panel (`--resfinder_species "Other"`). |

## Sourmash comparison

The parameteers below, configure how [sourmash](https://sourmash.readthedocs.io/en/latest/) is executed in the pipeline. They are relatively simple, and have sensible defaults.

| <div style="width:160px">Parameter</div> | Required | Default | Description |
| :--------------------------------------- | :------- | :------ | :---------- |
| `--sourmash_kmer` | :material-close: | 31 | Kmer size for sourmash genome comparison |
| `--sourmash_scale` | :material-close: | 1000 | Scale for for sourmash genome comparison. A scale 1000 on a 5Mb genome will generate 5000 hashes. 1000 is generally recommended by the tool's developers |

## On/Off processes

| <div style="width:180px">Parameter</div> | Required | Default | Description |
Expand Down

0 comments on commit d6d28b0

Please sign in to comment.