Create aggregate bioinformatics analysis reports across many samples and tools
Project description
Aggregate bioinformatics results across many samples into a single report
Find documentation and example reports at http://multiqc.info
MultiQC is a tool to create a single report with interactive plots for multiple bioinformatics analyses across many samples.
Reports are generated by scanning given directories for recognised log files. These are parsed and a single HTML report is generated summarising the statistics for all logs found. MultiQC reports can describe multiple analysis steps and large numbers of samples within a single plot, and multiple analysis tools making it ideal for routine fast quality control.
A very large number of Bioinformatics tools are supported by MultiQC. Please see the MultiQC website for a complete list. MultiQC can also easily parse data from custom scripts, if correctly formatted / configured - a feature called Custom Content.
More modules are being written all the time. Please suggest any ideas as a new issue (please include example log files).
Installation
You can install MultiQC from PyPI
using pip as follows:
pip install multiqc
Alternatively, you can install using Conda from Bioconda (set up your channels first):
conda install multiqc
If you would like the development version from GitHub instead, you can install it with pip:
pip install --upgrade --force-reinstall git+https://github.com/MultiQC/MultiQC.git
MultiQC is also available via Docker and Singularity images, Galaxy wrappers, and many more software distribution systems. See the documentation for details.
Usage
Once installed, you can use MultiQC by navigating to your analysis directory (or a parent directory) and running the tool:
multiqc .
That's it! MultiQC will scan the specified directory (. is the current dir)
and produce a report detailing whatever it finds.
The report is created in multiqc_report.html by default. Tab-delimited data
files are also created in multiqc_data/, containing extra information.
These can be easily inspected using Excel (use --data-format to get yaml
or json instead).
For more detailed instructions, run multiqc -h or see the
documentation.
Citation
Please consider citing MultiQC if you use it in your analysis.
MultiQC: Summarize analysis results for multiple tools and samples in a single report.
Philip Ewels, Måns Magnusson, Sverker Lundin and Max Käller
Bioinformatics (2016)
doi: 10.1093/bioinformatics/btw354
PMID: 27312411
@article{doi:10.1093/bioinformatics/btw354,
author = {Ewels, Philip and Magnusson, Måns and Lundin, Sverker and Käller, Max},
title = {MultiQC: summarize analysis results for multiple tools and samples in a single report},
journal = {Bioinformatics},
volume = {32},
number = {19},
pages = {3047},
year = {2016},
doi = {10.1093/bioinformatics/btw354},
URL = { + http://dx.doi.org/10.1093/bioinformatics/btw354},
eprint = {/oup/backfile/Content_public/Journal/bioinformatics/32/19/10.1093_bioinformatics_btw354/3/btw354.pdf}
}
Contributions & Support
Contributions and suggestions for new features are welcome, as are bug reports! Please create a new issue for any of these, including example reports where possible. Pull-requests for fixes and additions are very welcome. Please see the contributing notes for more information about how the process works.
MultiQC has extensive documentation describing how to write new modules, plugins and templates.
If in doubt, feel free to get in touch with the author directly: @ewels (phil.ewels@seqera.io)
Contributors
MultiQC is developed and maintained by Phil Ewels (@ewels) at Seqera Labs. It was originally written at the National Genomics Infrastructure, part of SciLifeLab in Sweden.
A huge thank you to all code contributors - there are a lot of you! See the Contributors Graph for details.
MultiQC is released under the GPL v3 or later licence.
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file multiqc-1.22.1.tar.gz.
File metadata
- Download URL: multiqc-1.22.1.tar.gz
- Upload date:
- Size: 4.2 MB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.0.0 CPython/3.12.3
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 0da0d7160efe06958056747b7e09a2b227848c0df1d28eddd2b052987910a8c2 |
|
| MD5 | 28519c5fb25088a7580a74b98391332f |
|
| BLAKE2b-256 | 6efa2f25f892aaa7ef113f18c546ecdf3439fddd1ab1bfbc2bcd113b9ed2e3b6 |
File details
Details for the file multiqc-1.22.1-py3-none-any.whl.
File metadata
- Download URL: multiqc-1.22.1-py3-none-any.whl
- Upload date:
- Size: 4.5 MB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.0.0 CPython/3.12.3
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 6eb9bd36aafba2c587b876db3c93be149aec35d0de23b52b4a5461f48122dd45 |
|
| MD5 | a60114e3c0826f8b7c90a444feb43d29 |
|
| BLAKE2b-256 | f612f2dc24575e39d559e759aa02b4fb63d5e1e1a025420d08c497346b229e9c |
