moonso / MultiQC

Aggregate results from bioinformatics analyses across many samples into a single report.

Aggregate bioinformatics results across many samples into a single report.

Find documentation and example reports at multiqc.info

---

MultiQC is written in Python and contains modules for a number of common tools. Currently, these include:

• FastQC
• FastQ Screen
• Cutadapt
• Bismark
• STAR
• Tophat
• Bowtie
• Bowtie 2
• Subread featureCounts
• Picard MarkDuplicates

More to come soon. Please suggest any ideas as a new issue.

Graphical Usage

MultiQC comes with a graphical app for OS X. To use, download MultiQC.app.zip from the releases page and unzip the archive. Double click MultiQC.app to launch, then drag your analysis directory onto the window.

The app can be run from anywhere, though we recommend copying to your Applications directory.

A similar graphical utility for Windows is planned for a future release.

Command Line Usage

You can install MultiQC from PyPI using pip as follows:

pip install multiqc

If you would like the development version instead, the command is:

pip install git+https://github.com/ewels/MultiQC.git

Then it's just a case of going to your analysis directory and running the script:

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/multiqc_report.html by default. A zip file of the report is also generated to facilitate easy transfer and sharing.

Tab-delimited data files are also created in multiqc_report/report_data/, containing extra information. These can be easily inspected using Excel.

For more detailed instructions, run multiqc -h

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 with new code are always gladly received, see the contributing notes for details. These notes include extensive help with how to use the built in code.

If in doubt, feel free to get in touch with the author: @ewels ([e-mail])

Version History

v0.2 - 2015-09-18

• Code restructuring for nearly all modules. Common base module functions now handle many more functions (plots, config, file import)
  • See the contributing notes for instructions on how to use these new helpers to make your own module
• New report toolbox - sample highlighting, renaming, hiding
  • Config is autosaved by default, can also export to a file for sharing
  • Interactive tour to help users find their way around
• New Tophat, Bowtie 2 and QualiMap modules
  • Thanks to @guillermo-carrasco for the QualiMap module
• Bowtie module now works
• New command line parameter -d prefixes sample names with the directory that they were found in. Allows duplicate filenames without being overwritten.
• Introduction walkthrough helps show what can be done in the report
• Now compatible with both Python 2 and Python 3
• Software version number now printed on command line properly, and in reports.
• Bugfix: FastQC doesn't break when only one report found
• Bugfix: FastQC seq content heatmap highlighting
• Many, many small bugfixes

v0.1 - 2015-09-01

• The first public release of MultiQC, after a month of development. Basic structure in place and modules for FastQC, FastQ Screen, Cutadapt, Bismark, STAR, Bowtie, Subread featureCounts and Picard MarkDuplicates. Approaching stability, though still under fairly heavy development.