Skip to content

Commit

Permalink
Update output.md
Browse files Browse the repository at this point in the history
  • Loading branch information
danilodileo authored Oct 25, 2023
1 parent 0482cf3 commit 80d5a4c
Showing 1 changed file with 11 additions and 8 deletions.
19 changes: 11 additions & 8 deletions docs/output.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ The pipeline is built using [Nextflow](https://www.nextflow.io/) and processes d
- [Summary tables folder](#summary-tables-folder) - Final tables that can be imported directly in R
- [Preprocessing](#preprocessing)
- [FastQC](#fastqc) - Read quality control
- [Trimgalore](#trimgalore) - Primer trimming
- [Trim galore!](#trimgalore) - Primer trimming
- [MultiQC](#multiqc) - Aggregate report describing results
- [BBduk](#bbduk) - Filter out sequences from samples based on a fasta file (optional)
- [BBnorm](#bbnorm) - Normalize the reads in the samples for a better assembly output (optional)
Expand All @@ -24,7 +24,7 @@ The pipeline is built using [Nextflow](https://www.nextflow.io/) and processes d
- [Prodigal](#prodigal) - Output from Prodigal (default)
- [Prokka](#prokka) - Output from Prokka (optional)
- [TransDecoder](#transdecoder) - Output from transdecoder (optional)
- [Functional and taxonomical annotation](#functional-and-taxonomical-annotation) - Predict the function out of the amino acids fasta file
- [Functional and taxonomical annotation](#functional-and-taxonomical-annotation) - Predict the function and the taxonomy of the amino acids fasta file
- [HMMER](#hmmer) - Analysis made with Hmmr profiles
- [EggNOG](#eggnog) - Run EggNOG-mapper on amino acids fasta file
- [KOfamSCAN](#kofamscan) - Run KOfamSCAN on amino acids fasta file
Expand All @@ -40,15 +40,15 @@ A summary report for all statistics results in tsv format. The report gives a ge
- `summary_tables/`
- `overall_stats.tsv`: statistics summary report.
- `*counts.tsv`: summary table for featureCounts outputs
- `*.tsv`: several tables based on different combination of the pipeline. From taxonomical to functional annotation (optional)
- `*.tsv`: several tables based on the different combinations of the pipeline. From taxonomical to functional annotation (optional)

</details>

### Preprocessing

#### FastQC

[FastQC](http://www.bioinformatics.babraham.ac.uk/projects/fastqc/) gives general quality metrics about your sequenced reads. It provides information about the quality score distribution across your reads, per base sequence content (%A/T/G/C), adapter contamination and overrepresented sequences. For further reading and documentation see the [FastQC help pages](http://www.bioinformatics.babraham.ac.uk/projects/fastqc/Help/). FastQC runs in trimgalore therefore its output can be found in Trimgalore's folder.
[FastQC](http://www.bioinformatics.babraham.ac.uk/projects/fastqc/) gives general quality metrics about your sequenced reads. It provides information about the quality score distribution across your reads, per base sequence content (%A/T/G/C), adapter contamination and overrepresented sequences. For further reading and documentation see the [FastQC help pages](http://www.bioinformatics.babraham.ac.uk/projects/fastqc/Help/). FastQC runs in Trim galore! therefore its output can be found in Trimgalore's folder.

<details markdown="1">
<summary>Output files</summary>
Expand All @@ -58,7 +58,7 @@ A summary report for all statistics results in tsv format. The report gives a ge

</details>

#### Trimgalore
#### Trim galore!

[Trimgalore](https://github.com/FelixKrueger/TrimGalore) is trimming primer sequences from sequencing reads. Primer sequences are non-biological sequences that often introduce point mutations that do not reflect sample sequences. This is especially true for degenerated PCR primer. If primer trimming would be omitted, artifactual amplicon sequence variants might be computed by the denoising tool or sequences might be lost due to become labelled as PCR chimera.

Expand Down Expand Up @@ -193,6 +193,7 @@ TransDecoder is reccomended for Eukaryotic samples
### Functional and taxonomical annotation

#### Hmmer

You can run HMMer scan on the reference amino acids fasta file by giving hmm profiles to the pipeline.

<details markdown="1">
Expand All @@ -204,6 +205,7 @@ You can run HMMer scan on the reference amino acids fasta file by giving hmm pro
</details>

Automatically, the pipline will run Hmmrank in order to find the best rank for each ORFs of your reference file.

<details markdown="1">
<summary>Output files</summary>

Expand All @@ -213,7 +215,8 @@ Automatically, the pipline will run Hmmrank in order to find the best rank for e
</details>

#### EggNOG
EggNOG-mapper will perform an analysis to functional annotate the ORFs

EggNOG-mapper will perform an analysis to assign a function to the ORFs

<details markdown="1">
<summary>Output files</summary>
Expand All @@ -227,6 +230,7 @@ EggNOG-mapper will perform an analysis to functional annotate the ORFs

#### KOfamScan

KOfamScan will perform an analysis to assign a function to the ORFs

<details markdown="1">
<summary>Output files</summary>
Expand All @@ -238,7 +242,7 @@ EggNOG-mapper will perform an analysis to functional annotate the ORFs

#### EUKulele


EUKulele will perform an analysis to assign a taxonomy to the ORFs
<details markdown="1">
<summary>Output files</summary>

Expand All @@ -247,7 +251,6 @@ EggNOG-mapper will perform an analysis to functional annotate the ORFs
- `eukulele/assembler.orfcaller/taxonomy_estimation/`
- `*-estimated-taxonomy.out.gz`: EUKulele output


</details>

### Pipeline information
Expand Down

0 comments on commit 80d5a4c

Please sign in to comment.