File: flash.md

package info (click to toggle)
multiqc 1.21%2Bdfsg-3
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 30,164 kB
  • sloc: python: 52,323; javascript: 7,064; sh: 76; makefile: 21
file content (31 lines) | stat: -rw-r--r-- 1,213 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
---
name: FLASh
url: https://ccb.jhu.edu/software/FLASH/
description: >
  FLASH (Fast Length Adjustment of SHort reads) is a very fast and accurate software tool to merge paired-end reads from NGS data.
---

The FLASh module parses the log messages generated by the [FLASh](https://ccb.jhu.edu/software/FLASH/) read merger. To create a log file, you can use `tee`. From the FLASh help:

```bash
flash reads_1.fq reads_2.fq 2>&1 | tee logfilename.log
```

The sample name is set by the first input filename listed in the log. However, this can be changed to using the first output filename (i.e. if you used FLASh's `--output-prefix=PREFIX` option) by using the following config:

```yaml
flash:
  use_output_name: true
```

The module can also parse the `.hist` numeric histograms output by FLASh.

Note that the histogram's file format and extension are too generic by themselves which could result in the accidental parsing a file output by another tool. To get around this, the MultiQC module only parses files with the filename pattern `*flash*.hist`.

To customise this (for example, enabling for any file ending in `*.hist`), use the following config change:

```yaml
sp:
  flash/hist:
    fn: "*.hist"
```