1
0
Fork 0
mirror of https://github.com/MillironX/taxprofiler.git synced 2024-09-21 04:42:04 +00:00

Update output and usage

This commit is contained in:
sofstam 2023-01-17 15:38:56 +01:00
parent 244fe5e30d
commit 024b683671
2 changed files with 17 additions and 2 deletions

View file

@ -58,7 +58,9 @@ The pipeline is built using [Nextflow](https://www.nextflow.io/) and processes d
### fastp ### fastp
fastp can automatically detect adapter sequences for Illumina data. [fastp](https://github.com/OpenGene/fastp) is a FASTQ pre-processing tool for quality control, trimmming of adapters, quality filtering and other features.
It is used in nf-core/taxprofiler for adapter trimming of short-reads.
<details markdown="1"> <details markdown="1">
<summary>Output files</summary> <summary>Output files</summary>
@ -141,6 +143,8 @@ Note that the FASTQ file(s) may _not_ always be the 'final' reads that go into t
### Filtlong ### Filtlong
[Filtlong](https://github.com/rrwick/Filtlong) is a quality filtering tool for long reads.
<details markdown="1"> <details markdown="1">
<summary>Output files</summary> <summary>Output files</summary>
@ -172,6 +176,10 @@ Note that the FASTQ file(s) may _not_ always be the 'final' reads that go into t
### minimap2 ### minimap2
[minimap2](https://github.com/lh3/minimap2) is an alignment tool suited to mapping long reads to reference sequences.
It is used with nf-core/taxprofiler to allow removal of 'host' (e.g. human) or other possible contaminant reads from the FASTQ files prior to taxonomic classification/profiling.
<details markdown="1"> <details markdown="1">
<summary>Output files</summary> <summary>Output files</summary>
@ -182,6 +190,8 @@ Note that the FASTQ file(s) may _not_ always be the 'final' reads that go into t
### Samtools stats ### Samtools stats
[Samtools stats](http://www.htslib.org/doc/samtools-stats.html) collects statistics from an alignment file and outputs in a text format.
<details markdown="1"> <details markdown="1">
<summary>Output files</summary> <summary>Output files</summary>
@ -254,6 +264,8 @@ You will only receive the FASTQs and `*classifiedreads.txt` file if you supply `
### Centrifuge ### Centrifuge
[Centrifuge](https://github.com/DaehwanKimLab/centrifuge) is a taxonomic sequence classifier that uses a Burrows-Wheeler transform and Ferragina-Manzina index for storing and mapping sequences.
<details markdown="1"> <details markdown="1">
<summary>Output files</summary> <summary>Output files</summary>
@ -279,6 +291,8 @@ You will only receive the FASTQs and `*classifiedreads.txt` file if you supply `
### DIAMOND ### DIAMOND
[DIAMOND](https://github.com/bbuchfink/diamond) is a sequence aligner for translated DNA searches or protein sequences against a protein reference database such as NR. It is a replacement for the NCBI BLAST software tools.It has many key features and it is used as taxonomic classifier in nf-core/taxprofiler.
<details markdown="1"> <details markdown="1">
<summary>Output files</summary> <summary>Output files</summary>
@ -328,6 +342,8 @@ 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 ### mOTUs
[mOTUS](https://github.com/motu-tool/mOTUs) maps reads to a unique marker specific database and estimates the relative abundance of known and unknown species.
<details markdown="1"> <details markdown="1">
<summary>Output files</summary> <summary>Output files</summary>

View file

@ -631,7 +631,6 @@ krakenuniq-build --db <DB_DIR_NAME> --kmer-len 31
Please see the [KrakenUniq documentation](https://github.com/fbreitwieser/krakenuniq#database-building) for more information. Please see the [KrakenUniq documentation](https://github.com/fbreitwieser/krakenuniq#database-building) for more information.
````
#### MALT custom database #### MALT custom database