millironx/taxprofiler
1
0
Fork 0
mirror of https://github.com/MillironX/taxprofiler.git synced 2024-11-21 22:46:04 +00:00
Code Issues Releases Packages Activity

Merge pull request #290 from nf-core/motus-docs-improvements

Browse source 
Improve mOTUS database input description
This commit is contained in:
James A. Fellows Yates 2023-04-29 18:36:18 +02:00 committed by GitHub
commit 89096beb61
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 4 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

1
CHANGELOG.md
View file

@ -19,6 +19,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
- [#275](https://github.com/nf-core/taxprofiler/pull/275/files) Replaced function used for error reporting to more Nextflow friendly method (fix by @jfy133) - [#275](https://github.com/nf-core/taxprofiler/pull/275/files) Replaced function used for error reporting to more Nextflow friendly method (fix by @jfy133)
- [#285](https://github.com/nf-core/taxprofiler/pull/285/files) Fixed overly large log files in Kraken2 output (♥ to @prototaxites for reporting, fix by @Midnighter & @jfy133) - [#285](https://github.com/nf-core/taxprofiler/pull/285/files) Fixed overly large log files in Kraken2 output (♥ to @prototaxites for reporting, fix by @Midnighter & @jfy133)
- [#286](https://github.com/nf-core/taxprofiler/pull/286/files) Runtime optimisation of MultiQC step via improved log file processing (fix by @Midnighter & @jfy133) - [#286](https://github.com/nf-core/taxprofiler/pull/286/files) Runtime optimisation of MultiQC step via improved log file processing (fix by @Midnighter & @jfy133)
- [#290](https://github.com/nf-core/taxprofiler/pull/286/files) Minor database input documentation improvements (♥ to @alneberg for reporting, fix by @jfy133)
### `Dependencies` ### `Dependencies`

6
docs/usage.md
View file

@ -120,7 +120,7 @@ Column specifications are as follows:
nf-core/taxprofiler will automatically decompress and extract any compressed archives for you. nf-core/taxprofiler will automatically decompress and extract any compressed archives for you.
The (uncompressed) database paths (`db_path`) for each tool are expected to contain the contents of: The (uncompressed) database paths (`db_path`) for each tool are expected to contain:
- [**Bracken**:](#bracken-custom-database) output of the combined `kraken2-build` and `bracken-build` process. - [**Bracken**:](#bracken-custom-database) output of the combined `kraken2-build` and `bracken-build` process.
- [**Centrifuge**:](#centrifuge-custom-database) output of `centrifuge-build`. - [**Centrifuge**:](#centrifuge-custom-database) output of `centrifuge-build`.
@ -130,9 +130,9 @@ The (uncompressed) database paths (`db_path`) for each tool are expected to cont
- [**KrakenUniq**:](#krakenuniq-custom-database) output of `krakenuniq-build` command(s). - [**KrakenUniq**:](#krakenuniq-custom-database) output of `krakenuniq-build` command(s).
- [**MALT**](#malt-custom-database) output of `malt-build`. - [**MALT**](#malt-custom-database) output of `malt-build`.
- [**MetaPhlAn3**:](#metaphlan3-custom-database) output of with `metaphlan --install` or downloaded from links on the [MetaPhlAn3 wiki](https://github.com/biobakery/MetaPhlAn/wiki/MetaPhlAn-3.0#customizing-the-database). - [**MetaPhlAn3**:](#metaphlan3-custom-database) output of with `metaphlan --install` or downloaded from links on the [MetaPhlAn3 wiki](https://github.com/biobakery/MetaPhlAn/wiki/MetaPhlAn-3.0#customizing-the-database).
- [**mOTUs**:](#motus-custom-database) is composed of code and database together. - [**mOTUs**:](#motus-custom-database) the directory `db_mOTU/` that is downloaded via `motus downloadDB`.
Click the links in the list above for short quick-reference tutorials how to generate custom databases for each tool. > ℹ️ Click the links in the list above for short quick-reference tutorials how to generate custom databases for each tool.
## Running the pipeline ## Running the pipeline