diff readme.rst @ 0:3bad335ccea9 draft

planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/multiqc commit 264fd61d39f252ebb81731bf6cd3349fdb39b306
author iuc
date Tue, 24 Oct 2017 06:29:59 -0400
parents
children b2f1f75d49c4
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/readme.rst	Tue Oct 24 06:29:59 2017 -0400
@@ -0,0 +1,21 @@
+Galaxy MultiQC wrapper
+========================
+
+Aggregate results from bioinformatics analyses across many samples into a single report
+
+MultiQC searches a given directory for analysis logs and compiles a HTML report. It's a general use tool, perfect for summarising the output from numerous bioinformatics tools.
+
+
+Prevent displaying MultiQC webpage as gibberish
+-----------------------------------------------
+
+For Galaxy to display MultiQC's HTML output properly, you need to either:
+
+1. Deactivate the sanitize_all_html option in galaxy.ini (sanitize_all_html = False), or
+2. Whitelist the tool in "Manage Display Whitelist" after installing
+
+Support new modules
+-------------------
+
+Currently, the wrapper supports the modules for tools found on the MTS.
+To add new ones, you can look at the patterns at https://github.com/ewels/MultiQC/blob/master/multiqc/utils/search_patterns.yaml