Skip to content

Commit eb84ad0

Browse files
committed
Add output docs
1 parent 4a46c5a commit eb84ad0

1 file changed

Lines changed: 46 additions & 1 deletion

File tree

docs/output.md

Lines changed: 46 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,20 +10,65 @@
1010
- [Secondary Output Directories](#secondary-output-directories)
1111
- [MultiQC Report](#multiqc-report)
1212
- [General Stats Table](#general-stats-table)
13+
- [Background](#background)
14+
- [Table](#table)
1315
- [FastQC](#fastqc)
16+
- [Background](#background-1)
17+
- [Sequence Counts](#sequence-counts)
18+
- [Sequence Quality Histograms](#sequence-quality-histograms)
19+
- [Per Sequence Quality Scores](#per-sequence-quality-scores)
20+
- [Per Base Sequencing Content](#per-base-sequencing-content)
21+
- [Per Sequence GC Content](#per-sequence-gc-content)
22+
- [Per Base N Content](#per-base-n-content)
23+
- [Sequence Duplication Levels](#sequence-duplication-levels)
24+
- [Overrepresented sequences](#overrepresented-sequences)
25+
- [Adapter Content](#adapter-content)
1426
- [FastP](#fastp)
27+
- [Background](#background-2)
28+
- [GC Content](#gc-content)
1529
- [AdapterRemoval](#adapterremoval)
30+
- [Background](#background-3)
31+
- [Retained and Discarded Reads Plot](#retained-and-discarded-reads-plot)
32+
- [Length Distribution Plot](#length-distribution-plot)
1633
- [Bowtie2](#bowtie2)
34+
- [Background](#background-4)
35+
- [Single/Paired-end alignments](#singlepaired-end-alignments)
1736
- [MALT](#malt)
37+
- [Background](#background-5)
38+
- [Metagenomic Mappability](#metagenomic-mappability)
39+
- [Taxonomic assignment success](#taxonomic-assignment-success)
1840
- [Kraken](#kraken)
41+
- [Background](#background-6)
42+
- [Top Taxa](#top-taxa)
1943
- [Samtools](#samtools)
44+
- [Background](#background-7)
45+
- [Flagstat Plot](#flagstat-plot)
2046
- [DeDup](#dedup)
47+
- [Background](#background-8)
48+
- [DeDup Plot](#dedup-plot)
2149
- [Picard](#picard)
50+
- [Background](#background-9)
51+
- [Mark Duplicates](#mark-duplicates)
2252
- [Preseq](#preseq)
53+
- [Background](#background-10)
54+
- [Complexity Curve](#complexity-curve)
2355
- [DamageProfiler](#damageprofiler)
56+
- [Background](#background-11)
57+
- [Misincorporation Plots](#misincorporation-plots)
58+
- [Length Distribution](#length-distribution)
2459
- [QualiMap](#qualimap)
60+
- [Background](#background-12)
61+
- [Coverage Histogram](#coverage-histogram)
62+
- [Cumulative Genome Coverage](#cumulative-genome-coverage)
63+
- [GC Content Distribution](#gc-content-distribution)
2564
- [Sex.DetERRmine](#sexdeterrmine)
65+
- [Background](#background-13)
66+
- [Relative Coverage](#relative-coverage)
67+
- [Read Counts](#read-counts)
2668
- [MultiVCFAnalyzer](#multivcfanalyzer)
69+
- [Background](#background-14)
70+
- [Summary metrics](#summary-metrics)
71+
- [Call statistics barplot](#call-statistics-barplot)
2772
- [Output Files](#output-files)
2873

2974
## Introduction
@@ -682,7 +727,7 @@ Each module has it's own output directory which sit alongside the `MultiQC/` dir
682727
- `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.
683728
- `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).
684729
- `metagenomic_classification/` This contains the output for a given metagenomic classifier.
685-
- 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.
730+
- 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. This will also include gzip SAM files if requested.
686731
- Kraken will contain the Kraken output and report files, as well as a merged Taxon count table.
687732
- `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)
688733
- `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 uncertainty system used for other downstream tools, respectively.

0 commit comments

Comments
 (0)