annotate readme.rst @ 3:fb44dede6db8 draft

planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/multiqc commit 4a9e5506db1a6b93486b617162e1b59abcdd0f1b
author iuc
date Fri, 17 Nov 2017 13:26:48 -0500
parents b437798cb165
children 0878c2af7b86
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
b437798cb165 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/multiqc commit 264fd61d39f252ebb81731bf6cd3349fdb39b306
iuc
parents:
diff changeset
1 Galaxy MultiQC wrapper
b437798cb165 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/multiqc commit 264fd61d39f252ebb81731bf6cd3349fdb39b306
iuc
parents:
diff changeset
2 ========================
b437798cb165 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/multiqc commit 264fd61d39f252ebb81731bf6cd3349fdb39b306
iuc
parents:
diff changeset
3
b437798cb165 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/multiqc commit 264fd61d39f252ebb81731bf6cd3349fdb39b306
iuc
parents:
diff changeset
4 Aggregate results from bioinformatics analyses across many samples into a single report
b437798cb165 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/multiqc commit 264fd61d39f252ebb81731bf6cd3349fdb39b306
iuc
parents:
diff changeset
5
b437798cb165 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/multiqc commit 264fd61d39f252ebb81731bf6cd3349fdb39b306
iuc
parents:
diff changeset
6 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.
b437798cb165 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/multiqc commit 264fd61d39f252ebb81731bf6cd3349fdb39b306
iuc
parents:
diff changeset
7
b437798cb165 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/multiqc commit 264fd61d39f252ebb81731bf6cd3349fdb39b306
iuc
parents:
diff changeset
8
b437798cb165 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/multiqc commit 264fd61d39f252ebb81731bf6cd3349fdb39b306
iuc
parents:
diff changeset
9 Prevent displaying MultiQC webpage as gibberish
b437798cb165 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/multiqc commit 264fd61d39f252ebb81731bf6cd3349fdb39b306
iuc
parents:
diff changeset
10 -----------------------------------------------
b437798cb165 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/multiqc commit 264fd61d39f252ebb81731bf6cd3349fdb39b306
iuc
parents:
diff changeset
11
b437798cb165 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/multiqc commit 264fd61d39f252ebb81731bf6cd3349fdb39b306
iuc
parents:
diff changeset
12 For Galaxy to display MultiQC's HTML output properly, you need to either:
b437798cb165 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/multiqc commit 264fd61d39f252ebb81731bf6cd3349fdb39b306
iuc
parents:
diff changeset
13
b437798cb165 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/multiqc commit 264fd61d39f252ebb81731bf6cd3349fdb39b306
iuc
parents:
diff changeset
14 1. Deactivate the sanitize_all_html option in galaxy.ini (sanitize_all_html = False), or
b437798cb165 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/multiqc commit 264fd61d39f252ebb81731bf6cd3349fdb39b306
iuc
parents:
diff changeset
15 2. Whitelist the tool in "Manage Display Whitelist" after installing
b437798cb165 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/multiqc commit 264fd61d39f252ebb81731bf6cd3349fdb39b306
iuc
parents:
diff changeset
16
b437798cb165 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/multiqc commit 264fd61d39f252ebb81731bf6cd3349fdb39b306
iuc
parents:
diff changeset
17 Support new modules
b437798cb165 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/multiqc commit 264fd61d39f252ebb81731bf6cd3349fdb39b306
iuc
parents:
diff changeset
18 -------------------
b437798cb165 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/multiqc commit 264fd61d39f252ebb81731bf6cd3349fdb39b306
iuc
parents:
diff changeset
19
b437798cb165 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/multiqc commit 264fd61d39f252ebb81731bf6cd3349fdb39b306
iuc
parents:
diff changeset
20 Currently, the wrapper supports the modules for tools found on the MTS.
b437798cb165 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/multiqc commit 264fd61d39f252ebb81731bf6cd3349fdb39b306
iuc
parents:
diff changeset
21 To add new ones, you can look at the patterns at https://github.com/ewels/MultiQC/blob/master/multiqc/utils/search_patterns.yaml