You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/usage.md
+6-5Lines changed: 6 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -889,7 +889,7 @@ The name of the chromosome X in your bam. `'X'` for hs37d5, `'chrX'` for HG19. D
889
889
890
890
### Metagenomic Screening
891
891
892
-
An increasingly common line of analysis in high-throughput aDNA analysis today is simultaenously screening off target reads of the host for endogenous microbial signals - particularly of pathogens. Metagenomic screening is currently offered via MALT with aDNA specific verification via MaltExtract.
892
+
An increasingly common line of analysis in high-throughput aDNA analysis today is simultaenously screening off target reads of the host for endogenous microbial signals - particularly of pathogens. Metagenomic screening is currently offered via MALT with aDNA specific verification via MaltExtract, or Kraken2.
893
893
894
894
Please note the following:
895
895
@@ -899,20 +899,19 @@ Please note the following:
899
899
900
900
> RUNNING MALT ON A SERVER WITH LESS THAN 128GB OF MEMORY SHOULD BE PERFORMED AT YOUR OWN RISK
901
901
902
-
#### -`-run_metagenomic_screening`
902
+
#### `--run_metagenomic_screening`
903
903
904
904
Turn on the metagenomic screening module.
905
905
906
906
#### `--metagenomic_tool`
907
907
908
908
Specify which taxonomic classifier to use. There are two options avaliable:
909
909
910
+
-`kraken` with [Kraken2](https://ccb.jhu.edu/software/kraken2)
910
911
-`malt` : more can be seen in the [MALT documentation](http://ab.inf.uni-tuebingen.de/data/software/malt/download/manual.pdf)
911
912
912
913
:warning:**Important** It is very important to run `nextflow clean -f` on your nextflow run directory once completed. RMA6 files are VERY large and are _copied_ from a `work/` directory into the results folder. You should clean the work directory with the command to ensure non-redundency and large HDD footprints!
913
914
914
-
-`kraken` with [Kraken2](https://ccb.jhu.edu/software/kraken2)
915
-
916
915
#### `--metagenomic_min_support_reads`
917
916
918
917
Specify the minimum number of reads a given taxon is required to have to be retained as a positive 'hit'.
@@ -928,12 +927,14 @@ For Kraken2, it can be either the path to the _directory_ or the path to the `.t
928
927
929
928
Specify the minimum percent identity (or similarity) a squence must have to the reference for it to be retained. Default is 85
930
929
930
+
Only used when `--metagenomic_tool malt` is also supplied
931
+
931
932
#### `--malt_mode`
932
933
933
934
Use this to run the program in 'BlastN', 'BlastP', 'BlastX' modes to align DNA and DNA, protein and protein, or DNA reads against protein references respectively.
934
935
respectively. Ensure your database matches the mode. Check the [MALT manual](http://ab.inf.uni-tuebingen.de/data/software/malt/download/manual.pdf) for more details. Default: 'BlastN'
935
936
936
-
Only when `--metagenomic_tool malt` is also supplied is also supplied
937
+
Only when `--metagenomic_tool malt` is also supplied
0 commit comments