diff --git a/docs/output.md b/docs/output.md index 2fae37a..ef791e1 100644 --- a/docs/output.md +++ b/docs/output.md @@ -64,6 +64,8 @@ fastp can automatically detect adapter sequences for Illumina data. Output files - `fastp` + - `.fastp.fastq.gz`: File with the trimmed unmerged fastq reads. + - `.merged.fastq.gz`: File with the reads that were successfully merged. @@ -95,7 +97,7 @@ Note that the FASTQ files may _not_ always be the 'final' reads that go into tax Output files - `porechop` - - `.fastq.gz` + - `.fastq.gz`: Adapter-trimmed file @@ -143,8 +145,8 @@ Note that the FASTQ file(s) may _not_ always be the 'final' reads that go into t Output files - `filtlong` - - `_filtered.fastq.g` - - `_filtered.log` + - `_filtered.fastq.gz`: Quality or short read data filtered file + - `_filtered.log`: log file containing summary statistics @@ -174,7 +176,7 @@ Note that the FASTQ file(s) may _not_ always be the 'final' reads that go into t Output files - `minimap2` - - `.bam` + - `.bam`: Alignment file in bam format @@ -184,7 +186,7 @@ Note that the FASTQ file(s) may _not_ always be the 'final' reads that go into t Output files - `samtoolsstats` - - `.stats` + - `.stats`: File containing samtools stats output @@ -204,7 +206,7 @@ Note that the FASTQ file(s) may _not_ always be the 'final' reads that go into t -The main taxonomic profiling file from KrakenUniq is the `*.tsv` file. This provides the basic results from Kraken2 but with the corrected abundance information. +The main taxonomic profiling file from KrakenUniq is the `*.tsv` file. This provides the basic results from Kraken2 but with the corrected abundance information. ### Kraken2 @@ -256,10 +258,11 @@ You will only receive the FASTQs and `*classifiedreads.txt` file if you supply ` Output files - `centrifuge` - - `.centrifuge.mapped.fastq.gz` - - `.centrifuge.report.txt` - - `.centrifuge.results.txt` - - `.centrifuge.unmapped.fastq.gz` + - `.centrifuge.mapped.fastq.gz`: Fastq files containing all mapped reads + - `.centrifuge.report.txt`: A classification report that summarises the taxonomic ID, the taxonomic rank, length of genome sequence, number of classified and uniquely classified reads + - `.centrifuge.results.txt`: A file that summarises the classification assignment for a read, i.e read ID, sequence ID, score for the classification, score for the next best classification, number of classifications for this read + - `.centrifuge.txt`: A Kraken2-style report that summarises the fraction abundance, taxonomic ID, number of k-mers, taxonomic path of all the hits in the centrifuge run for a given sample + - `.centrifuge.unmapped.fastq.gz`: Fastq file containing all unmapped reads @@ -269,7 +272,8 @@ You will only receive the FASTQs and `*classifiedreads.txt` file if you supply ` Output files - `kaiju` - - `.tsv` + - `.tsv`: A file that summarises the fraction abundance, taxonomic ID, number of reads and taxonomic names + - `kaiju__combined_reports.txt`: A combined profile of all samples aligned to a given database (as generated by `kaiju2table`) @@ -279,8 +283,8 @@ You will only receive the FASTQs and `*classifiedreads.txt` file if you supply ` Output files - `diamond` - - `.log` - - `.sam` + - `.log`: A log file containing stdout information + - `.sam`: A file in SAM format that contains the aligned reads @@ -321,22 +325,23 @@ You will only recieve the `.sam` and `.megan` files if you supply `--malt_save_r -The main taxonomic profiling file from MetaPhlAn3 is the `*_profile.txt` file. This provides the abundance estimates from MetaPhlAn3 however does not include raw counts by default. +The main taxonomic profiling file from MetaPhlAn3 is the `*_profile.txt` file. This provides the abundance estimates from MetaPhlAn3 however does not include raw counts by default. ### mOTUs
Output files - `motus` - - `.log` - - `.out` + - `.log`: A log file that contains summary statistics + - `.out`: A classification file that summarises taxonomic identifiers, by default at the rank of mOTUs (i.e., species level), and their relative abundances in the profiled sample. + - `motus__combined_reports.txt`: A combined profile of all samples aligned to a given database (as generated by `motus_merge`)
### Krona [Krona](https://github.com/marbl/Krona) is Krona allows the exploration of (metagenomic) hierarchical data with interactive zooming, multi-layered pie charts. -Krona charts will be generated by the pipeline for supported tools (Kraken2, Centrifuge, Kaiju, and MALT) +Krona charts will be generated by the pipeline for supported tools (Kraken2, Centrifuge, Kaiju, and MALT)
Output files