Skip to content

Commit 3e15c93

Browse files
committed
improve markdown linting
1 parent ba9ed15 commit 3e15c93

2 files changed

Lines changed: 8 additions & 8 deletions

File tree

docs/output.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -485,8 +485,8 @@ Each module has it's own output directory which sit alongside the `MultiQC/` dir
485485
* `sex_determination/` this contains the output for the sex determination run. This is a single `.tsv` file that includes a table with the Sample Name, the Nr of Autosomal SNPs, Nr of SNPs on the X/Y chromosome, the Nr of reads mapping to the Autosomes, the Nr of reads mapping to the X/Y chromosome, the relative coverage on the X/Y chromosomes, and the standard error associated with the relative coverages. These measures are provided for each bam file, one row per bam. If the `sexdeterrmine_bedfile` option has not been provided, the error bars cannot be trusted, and runtime will be considerably longer.
486486
* `nuclear_contamination/` this contains the output of the nuclear contamination processes. The directory contains one `*.X.contamination.out` file per individual, as well as `nuclear_contamination.txt` which is a summary table of the results for all individual. `nuclear_contamination.txt` contains a header, followed by one line per individual, comprised of the Method of Moments (MOM) and Maximum Likelihood (ML) contamination estimate (with their respective standard errors) for both Method1 and Method2.
487487
* `bedtools/` this contains two files as the output from bedtools coverage. One file contains the 'breadth' coverage (`*.breadth.gz`). This file will have the contents of your annotation file (e.g. BED/GFF), and the following subsequent columns: no. reads on feature, # bases at depth, length of feature, and % of feature. The second file (`*.depth.gz`), contains the contents of your annotation file (e.g. BED/GFF), and an additional column which is mean depth coverage (i.e. average number of reads covering each position).
488-
* `metagenomic_classification/` This contains the output for a given metagenomic classifer.
489-
- Malt will contain RMA6 files that can be loaded into MEGAN6 or MaltExtract for phylogenetic visualisation of read taxonomic assignments and aDNA characteristics respectively. Additional a `malt.log` file is provided which gives additional information such as run-time, memory usage and per-sample statistics of numbers of alignments with taxonomic assignment etc.
490-
- Kraken will contain the Kraken output and report files, as well as a merged Taxon count table.
488+
* `metagenomic_classification/` This contains the output for a given metagenomic classifer.
489+
* Malt will contain RMA6 files that can be loaded into MEGAN6 or MaltExtract for phylogenetic visualisation of read taxonomic assignments and aDNA characteristics respectively. Additional a `malt.log` file is provided which gives additional information such as run-time, memory usage and per-sample statistics of numbers of alignments with taxonomic assignment etc.
490+
* Kraken will contain the Kraken output and report files, as well as a merged Taxon count table.
491491
* `MaltExtract/` this will contain a `results` directory in which contains the output from MaltExtract - typically one folder for each filter type, an error and a log file. The characteristics of each node (e.g. damage, read lengths, edit distances - each in different txt formats) can be seen in each sub-folder of the filter folders. Output can be visualised either with the [HOPS postprocessing script](https://github.com/rhuebler/HOPS) or [MEx-IPA](https://github.com/jfy133/MEx-IPA)
492492
* `consensus_sequence` this contains three FASTA files from VCF2Genome, of a consensus sequence based on the reference FASTA with each sample's unique modifications. The main FASTA is a standard file with bases not passing the specified thresholds as Ns. The two other FASTAS (`_refmod.fasta.gz`) and (`_uncertainity.fasta.gz`) are IUPAC uncertainty codes (rather than Ns) and a special number-based uncertainity system used for other downstream tools, respectively.

docs/usage.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -906,13 +906,16 @@ Turn on the metagenomic screening module.
906906
#### `--metagenomic_tool`
907907

908908
Specify which taxonomic classifier to use. There are two options avaliable:
909+
909910
- `malt` : more can be seen in the [MALT documentation](http://ab.inf.uni-tuebingen.de/data/software/malt/download/manual.pdf)
911+
910912
: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!
911-
- `kraken` with [Kraken2](https://ccb.jhu.edu/software/kraken2)
913+
914+
- `kraken` with [Kraken2](https://ccb.jhu.edu/software/kraken2)
912915

913916
#### `--metagenomic_min_support_reads`
914917

915-
Specify the minimum number of reads a given taxon is required to have to be retained as a positive 'hit'.
918+
Specify the minimum number of reads a given taxon is required to have to be retained as a positive 'hit'.
916919
For malt, this only applies when `--malt_min_support_mode` is set to 'reads'. Default: 1 .
917920

918921
#### `--database`
@@ -938,7 +941,6 @@ Specify what alignment algorithm to use. Options are 'Local' or 'SemiGlobal'. Lo
938941

939942
Only when `--metagenomic_tool malt` is also supplied
940943

941-
942944
#### `--malt_top_percent`
943945

944946
Specify the top percent value of the LCA algorthim. From the [MALT manual](http://ab.inf.uni-tuebingen.de/data/software/malt/download/manual.pdf): "For each
@@ -947,14 +949,12 @@ read, only those matches are used for taxonomic placement whose bit disjointScor
947949

948950
Only when `--metagenomic_tool malt` is also supplied
949951

950-
951952
#### `--malt_min_support_mode`
952953

953954
Specify whether to use a percentage, or raw number of reads as the value used to decide the minimum support a taxon requires to be retained.
954955

955956
Only when `--metagenomic_tool malt` is also supplied
956957

957-
958958
#### `--malt_min_support_percent`
959959

960960
Specify the minimum number of reads (as a percentage of all assigned reads) a given taxon is required to have to be retained as a positive 'hit' in the RMA6 file. This only applies when `--malt_min_support_mode` is set to 'percent'. Default 0.01.

0 commit comments

Comments
 (0)