annotate readme.rst @ 8:e0f4a651c6b9 draft

planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/multiqc commit 13875b17a3a5259b9705529a3597bea12828cb20
author iuc
date Fri, 20 Apr 2018 01:06:25 -0400
parents 3bad335ccea9
children b2f1f75d49c4
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
3bad335ccea9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/multiqc commit 264fd61d39f252ebb81731bf6cd3349fdb39b306
iuc
parents:
diff changeset
1 Galaxy MultiQC wrapper
3bad335ccea9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/multiqc commit 264fd61d39f252ebb81731bf6cd3349fdb39b306
iuc
parents:
diff changeset
2 ========================
3bad335ccea9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/multiqc commit 264fd61d39f252ebb81731bf6cd3349fdb39b306
iuc
parents:
diff changeset
3
3bad335ccea9 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
3bad335ccea9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/multiqc commit 264fd61d39f252ebb81731bf6cd3349fdb39b306
iuc
parents:
diff changeset
5
3bad335ccea9 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.
3bad335ccea9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/multiqc commit 264fd61d39f252ebb81731bf6cd3349fdb39b306
iuc
parents:
diff changeset
7
3bad335ccea9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/multiqc commit 264fd61d39f252ebb81731bf6cd3349fdb39b306
iuc
parents:
diff changeset
8
3bad335ccea9 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
3bad335ccea9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/multiqc commit 264fd61d39f252ebb81731bf6cd3349fdb39b306
iuc
parents:
diff changeset
10 -----------------------------------------------
3bad335ccea9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/multiqc commit 264fd61d39f252ebb81731bf6cd3349fdb39b306
iuc
parents:
diff changeset
11
3bad335ccea9 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:
3bad335ccea9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/multiqc commit 264fd61d39f252ebb81731bf6cd3349fdb39b306
iuc
parents:
diff changeset
13
3bad335ccea9 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
3bad335ccea9 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
3bad335ccea9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/multiqc commit 264fd61d39f252ebb81731bf6cd3349fdb39b306
iuc
parents:
diff changeset
16
3bad335ccea9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/multiqc commit 264fd61d39f252ebb81731bf6cd3349fdb39b306
iuc
parents:
diff changeset
17 Support new modules
3bad335ccea9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/multiqc commit 264fd61d39f252ebb81731bf6cd3349fdb39b306
iuc
parents:
diff changeset
18 -------------------
3bad335ccea9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/multiqc commit 264fd61d39f252ebb81731bf6cd3349fdb39b306
iuc
parents:
diff changeset
19
3bad335ccea9 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.
3bad335ccea9 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