Skip to content

Commit

Permalink
Apply suggestions from code review
Browse files Browse the repository at this point in the history
  • Loading branch information
jasmezz authored Aug 21, 2024
1 parent 6b2172e commit 011fb56
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 6 deletions.
2 changes: 1 addition & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
- [#406](https://github.com/nf-core/funcscan/pull/406) Fixed prediction tools not being executed if annotation workflow skipped. (by @jasmezz)
- [#407](https://github.com/nf-core/funcscan/pull/407) Fixed comBGC bug when parsing multiple antiSMASH files. (by @jasmezz)
- [#409](https://github.com/nf-core/funcscan/pull/409) Fixed argNorm overwriting its output for DeepARG. (by @jasmezz, @jfy133)
- [#412](https://github.com/nf-core/funcscan/pull/412) Improve all pre-run database download documentation (by @jfy133)
- [#412](https://github.com/nf-core/funcscan/pull/412) Improve all pre-run database download documentation. (by @jfy133)

### `Dependencies`

Expand Down
10 changes: 5 additions & 5 deletions docs/usage.md
Original file line number Diff line number Diff line change
Expand Up @@ -171,10 +171,10 @@ You can do this by installing via conda and using the dedicated command
conda create -n bakta -c bioconda bakta
conda activate bakta
bakta_db download --output <LOCATION_TO_STORE --type <full|light>
bakta_db download --output <LOCATION_TO_STORE> --type <full|light>
```

Alternatively, you can manually download the filesvia the links of which can be found on the [Bakta GitHub repository](https://github.com/oschwengers/bakta#database-download).
Alternatively, you can manually download the files via the links which can be found on the [Bakta GitHub repository](https://github.com/oschwengers/bakta#database-download).

Once downloaded this must be untarred:

Expand Down Expand Up @@ -388,7 +388,7 @@ mmseqs databases <DATABASE_NAME> <LOCATION_TO_STORE> tmp/
```
:::info
You may want to specify a different location for `tmp/`, we just borrowed here from the official `mmseqs` [documentation](https://github.com/soedinglab/mmseqs2/wiki#downloading-databases)
You may want to specify a different location for `tmp/`, we just borrowed here from the official `mmseqs` [documentation](https://github.com/soedinglab/mmseqs2/wiki#downloading-databases).
:::
### RGI
Expand Down Expand Up @@ -431,14 +431,14 @@ The same applies for the antiSMASH installation directory, which is also a requi
To supply the database directories to the pipeline:
1. Install antiSMASH from [bioconda](https://bioconda.github.io/recipes/antismash-lite/README.html) (To ensure database compatibility, please use the same version as is used in your nf-core/funcscan release - check version in file `<pipeline_installation>/<path>/funcscan/modules/nf-core/amrfinderplus/run/environment.yml`)
1. Install antiSMASH from [bioconda](https://bioconda.github.io/recipes/antismash-lite/README.html). To ensure database compatibility, please use the same version as is used in your nf-core/funcscan release (check version in file `<pipeline_installation>/<path>/funcscan/modules/nf-core/antismash/antismashlite/environment.yml`).
```bash
conda create -n antismash-lite -c bioconda antismash-lite
conda activate antismash-lite
```
2. Run the following command `download-antismash-databases`. Use `--database-dir` to specify a new location.
2. Run the command `download-antismash-databases`. Use `--database-dir` to specify a new location.
3. You can then supply the paths to the resulting databases and the whole installation directory with:
```bash
Expand Down

0 comments on commit 011fb56

Please sign in to comment.