From 0b16010b92d7362e1accdc621f17fee99b824110 Mon Sep 17 00:00:00 2001 From: Sofia Stamouli <91951607+sofstam@users.noreply.github.com> Date: Wed, 12 Oct 2022 11:39:03 +0200 Subject: [PATCH] Add tutorials section --- docs/usage.md | 16 +++++++++++++++- 1 file changed, 15 insertions(+), 1 deletion(-) diff --git a/docs/usage.md b/docs/usage.md index 3c0e17d..0be44ed 100644 --- a/docs/usage.md +++ b/docs/usage.md @@ -228,7 +228,7 @@ Activating this functionality will concatenate the FASTQ files with the same sam You can optionally save the FASTQ output of the run merging with the `--save_runmerged_reads`. -##### Profiling +#### Profiling ###### MALT @@ -429,6 +429,20 @@ We recommend adding the following line to your environment to limit this (typica NXF_OPTS='-Xms1g -Xmx4g' ``` +## Tutorials + +### Tutorial - How to create your custom database + +#### Kraken2 +Kraken2 allows the user to build custom databases. You can follow Kraken2 [tutorial](https://github.com/DerrickWood/kraken2/blob/master/docs/MANUAL.markdown#custom-databases). + +#### Centrifuge +Centrifuge is similar to Kraken2 in that it enables to [build custom databases](https://ccb.jhu.edu/software/centrifuge/manual.shtml#custom-database). + +#### Kaiju +WIP + + ## Troubleshooting and FAQs ### I get a warning during centrifuge_kreport process with exit status 255.