millironx/taxprofiler
1
0
Fork 0
mirror of https://github.com/MillironX/taxprofiler.git synced 2024-11-10 22:53:08 +00:00
Code Issues Releases Packages Activity

Update docs/output.md

Browse source 
Co-authored-by: James A. Fellows Yates <jfy133@gmail.com>
This commit is contained in:
Sofia Stamouli 2022-12-20 15:44:35 +01:00 committed by GitHub
parent b0a6bdee5a
commit af8fd18d97
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 12 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

16
docs/output.md
View file

@ -148,16 +148,24 @@ Note that the FASTQ file(s) may _not_ always be the 'final' reads that go into t
### Bowtie2
[Bowtie 2](https://bowtie-bio.sourceforge.net/bowtie2/index.shtml) is an ultrafast and memory-efficient tool for aligning sequencing reads to long reference sequences. It is particularly good at aligning reads of about 50 up to 100s or 1,000s of characters, and particularly good at aligning to relatively long (e.g. mammalian) genomes.
It is used with nf-core/taxprofiler to allow removal of 'host' (e.g. human) or other possible contaminant reads (e.g. Phi X) from the FASTQ files prior to profiling.
<details markdown="1">
<summary>Output files</summary>
- `bowtie2`
- `<sample_id>.bam`
- `<sample_id>.bowtie2.log`
- `<sample_id>.unmapped.fastq.gz`
- `bowtie2/`
- `<sample_id>.bam`: reads that aligned against the user-supplied reference genome
- `<sample_id>.bowtie2.log`: log file about the mapped reads
- `<sample_id>.unmapped.fastq.gz`: the off-target reads from the mapping that is used in downstream steps.
</details>
By default nf-core/taxprofiler will only provide the `.log` file if host removal is turned on. You will only see the mapped (host) reads BAM file or the off-target reads in FASTQ format in your results directory if you provide `--save_hostremoval_mapped` and ` --save_hostremoval_unmapped` respectively.
Note that the FASTQ file(s) may _not_ always be the 'final' reads that go into taxprofiling, if you also run other steps such as host removal, run merging etc..
### minimap2
<details markdown="1">