Skip to content

Commit ace02e1

Browse files
committed
small syntax fixes
1 parent 3e15c93 commit ace02e1

1 file changed

Lines changed: 6 additions & 5 deletions

File tree

docs/usage.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -889,7 +889,7 @@ The name of the chromosome X in your bam. `'X'` for hs37d5, `'chrX'` for HG19. D
889889

890890
### Metagenomic Screening
891891

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.
893893

894894
Please note the following:
895895

@@ -899,20 +899,19 @@ Please note the following:
899899

900900
> RUNNING MALT ON A SERVER WITH LESS THAN 128GB OF MEMORY SHOULD BE PERFORMED AT YOUR OWN RISK
901901
902-
#### -`-run_metagenomic_screening`
902+
#### `--run_metagenomic_screening`
903903

904904
Turn on the metagenomic screening module.
905905

906906
#### `--metagenomic_tool`
907907

908908
Specify which taxonomic classifier to use. There are two options avaliable:
909909

910+
- `kraken` with [Kraken2](https://ccb.jhu.edu/software/kraken2)
910911
- `malt` : more can be seen in the [MALT documentation](http://ab.inf.uni-tuebingen.de/data/software/malt/download/manual.pdf)
911912

912913
: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!
913914

914-
- `kraken` with [Kraken2](https://ccb.jhu.edu/software/kraken2)
915-
916915
#### `--metagenomic_min_support_reads`
917916

918917
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
928927

929928
Specify the minimum percent identity (or similarity) a squence must have to the reference for it to be retained. Default is 85
930929

930+
Only used when `--metagenomic_tool malt` is also supplied
931+
931932
#### `--malt_mode`
932933

933934
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.
934935
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'
935936

936-
Only when `--metagenomic_tool malt` is also supplied is also supplied
937+
Only when `--metagenomic_tool malt` is also supplied
937938

938939
#### `--malt_alignment_mode`
939940

0 commit comments

Comments
 (0)