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
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
|
---
Using MultiQC:
Installation: installation.md
Running MultiQC: usage.md
Using Reports: reports.md
Configuration: config.md
Customising Reports: customisation.md
Using MultiQC in pipelines: pipelines.md
Downstream analysis: downstream.md
Common Problems: troubleshooting.md
MultiQC Modules:
Pre-alignment:
Adapter Removal: modules/adapterRemoval.md
AfterQC: modules/afterqc.md
Anglerfish: modules/anglerfish.md
BBDuk: modules/bbduk.md
Bcl2fastq: modules/bcl2fastq.md
BclConvert: modules/bclconvert.md
BioBloom Tools: modules/biobloomtools.md
CCS: modules/ccs.md
CheckQC: modules/checkqc.md
ClipAndMerge: modules/clipandmerge.md
Cluster Flow: modules/clusterflow.md
Cutadapt: modules/cutadapt.md
DRAGEN-FastQC: modules/dragen_fastqc.md
Fastp: modules/fastp.md
FastQ Screen: modules/fastq_screen.md
FastQC: modules/fastqc.md
Filtlong: modules/filtlong.md
FLASh: modules/flash.md
Flexbar: modules/flexbar.md
HiFiasm: modules/hifiasm.md
HUMID: modules/humid.md
InterOp: modules/interop.md
iVar: modules/ivar.md
Jellyfish: modules/jellyfish.md
KAT: modules/kat.md
leeHom: modules/leehom.md
Lima: modules/lima.md
minionqc: modules/minionqc.md
prinseqplusplus: modules/prinseqplusplus.md
pbmarkdup: modules/pbmarkdup.md
Porechop: modules/porechop.md
Pychopper: modules/pychopper.md
pycoQC: modules/pycoqc.md
SeqyClean: modules/seqyclean.md
Sickle: modules/sickle.md
Skewer: modules/skewer.md
SortMeRNA: modules/sortmerna.md
Trimmomatic: modules/trimmomatic.md
Aligners:
BBMap: modules/bbmap.md
Biscuit: modules/biscuit.md
Bismark: modules/bismark.md
Bowtie 1: modules/bowtie1.md
Bowtie 2: modules/bowtie2.md
Cell Ranger: modules/cellranger.md
DIAMOND: modules/diamond.md
DRAGEN: modules/dragen.md
HiCPro: modules/hicpro.md
HiCUP: modules/hicup.md
HISAT2: modules/hisat2.md
Kallisto: modules/kallisto.md
Long Ranger: modules/longranger.md
MALT: modules/malt.md
mOTUs: modules/motus.md
Salmon: modules/salmon.md
STAR: modules/star.md
TopHat: modules/tophat.md
Post-alignment:
Bamtools: modules/bamtools.md
Bcftools: modules/bcftools.md
biobambam2: modules/biobambam2.md
BUSCO: modules/busco.md
Bustools: modules/bustools.md
Conpair: modules/conpair.md
DamageProfiler: modules/damageprofiler.md
DeDup: modules/dedup.md
deepTools: modules/deeptools.md
Disambiguate: modules/disambiguate.md
EigenStratDatabseTools: modules/eigenstratdatabasetools.md
featureCounts: modules/featureCounts.md
fgbio: modules/fgbio.md
GATK: modules/gatk.md
GffCompare: modules/gffcompare.md
goleft_indexcov: modules/goleft_indexcov.md
gopeaks: modules/gopeaks.md
Hap.py: modules/happy.md
HiCExplorer: modules/hicexplorer.md
HOMER: modules/homer.md
HOPS: modules/hops.md
HTSeq: modules/htseq.md
JCVI: modules/jcvi.md
Kaiju: modules/kaiju.md
Kraken: modules/kraken.md
MACS2: modules/macs2.md
Methyl QA: modules/methylQA.md
mirtop: modules/mirtop.md
miRTrace: modules/mirtrace.md
mosdepth: modules/mosdepth.md
MTNucRatio: modules/mtnucratio.md
MultiVCFAnalyzer: modules/multivcfanalyzer.md
NanoStat: modules/nanostat.md
Nextclade: modules/nextclade.md
ngsderive: modules/ngsderive.md
odgi: modules/odgi.md
OptiType: modules/optitype.md
Pangolin: modules/pangolin.md
Peddy: modules/peddy.md
phantompeakqualtools: modules/phantompeakqualtools.md
Picard: modules/picard.md
Preseq: modules/preseq.md
Prokka: modules/prokka.md
PURPLE: modules/purple.md
qc3C: modules/qc3C.md
QoRTs: modules/qorts.md
Qualimap: modules/qualimap.md
Quast: modules/quast.md
RNA-SeQC: modules/rna_seqc.md
Rockhopper: modules/rockhopper.md
RSEM: modules/rsem.md
RSeQC: modules/rseqc.md
Sambamba: modules/sambamba.md
Samblaster: modules/samblaster.md
Samtools: modules/samtools.md
Sargasso: modules/sargasso.md
Sentieon: modules/sentieon.md
SexDetErrmine: modules/sexdeterrmine.md
Slamdunk: modules/slamdunk.md
Snippy: modules/snippy.md
SnpEff: modules/snpeff.md
SNPsplit: modules/snpsplit.md
Somalier: modules/somalier.md
Stacks: modules/stacks.md
Supernova: modules/supernova.md
THeTA2: modules/theta2.md
UMI-tools: modules/umitools.md
VarScan2: modules/varscan2.md
VCFTools: modules/vcftools.md
VEP: modules/vep.md
verifyBAMID: modules/verifybamid.md
WhatsHap: modules/whatshap.md
Custom Content:
Introduction: custom_content.md
Coding with MultiQC:
Writing new modules: modules.md
Plotting Functions: plots.md
MultiQC Plugins: plugins.md
Writing new templates: templates.md
Updating for compatibility: compatibility.md
---
# MultiQC Documentation
MultiQC is a tool to aggregate bioinformatics results across many samples
into a single report. It's written in Python and contains modules for a number
of common tools.
The documentation has the following pages:
- [Docs homepage](README.md) _(this README file)_
- Using MultiQC
- [Installing MultiQC](installation.md)
- [Running MultiQC](usage.md)
- [Using Reports](reports.md)
- [Configuration](config.md)
- [Customising Reports](customisation.md)
- [Using MultiQC in pipelines](pipelines.md)
- [Downstream analysis of MultiQC outputs](downstream.md)
- [Common Problems](troubleshooting.md)
- [MultiQC Modules](modules/)
- [Custom Content](custom_content.md)
- Coding with MultiQC
- [Writing new modules](modules.md)
- [Plotting functions](plots.md)
- [MultiQC Plugins](plugins.md)
- [Writing new templates](templates.md)
- [Updating for compatibility](compatibility.md)
These docs can be read in any of three ways:
- On the MultiQC Website: <http://multiqc.info>
- On GitHub: <https://github.com/ewels/MultiQC/>
- As part of the distributed source code (in `/docs/`)
If you're curious how the website works, check out the
[MultiQC website repository](https://github.com/ewels/MultiQC_website).
## Contributing to MultiQC
If you write a module which could be of use to others, it would be great to
merge those changes back into the core MultiQC project.
For instructions on how best to do this, please see the
[contributing instructions](https://github.com/ewels/MultiQC/blob/master/.github/CONTRIBUTING.md).
|
