annotate readme.rst @ 24:f7e2f1eb3a16 draft default tip

planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/multiqc commit dffbb5d421a5a5773bcb7f05933b12c45461bb58
author iuc
date Mon, 02 Sep 2024 14:22:54 +0000
parents b2f1f75d49c4
children
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
14
b2f1f75d49c4 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/multiqc commit fb0d9f3e89dc31e481f4bdb3e498a713f9e60def
iuc
parents: 0
diff changeset
17 Problems with encodings
b2f1f75d49c4 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/multiqc commit fb0d9f3e89dc31e481f4bdb3e498a713f9e60def
iuc
parents: 0
diff changeset
18 -----------------------
b2f1f75d49c4 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/multiqc commit fb0d9f3e89dc31e481f4bdb3e498a713f9e60def
iuc
parents: 0
diff changeset
19
b2f1f75d49c4 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/multiqc commit fb0d9f3e89dc31e481f4bdb3e498a713f9e60def
iuc
parents: 0
diff changeset
20 If you observe python Runtime errors because python3 is configured to use ASCII then set
b2f1f75d49c4 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/multiqc commit fb0d9f3e89dc31e481f4bdb3e498a713f9e60def
iuc
parents: 0
diff changeset
21 `LC_ALL` and `LANG` in your job_conf.xml. See also https://github.com/galaxyproject/tools-iuc/issues/2362.
b2f1f75d49c4 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/multiqc commit fb0d9f3e89dc31e481f4bdb3e498a713f9e60def
iuc
parents: 0
diff changeset
22
0
3bad335ccea9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/multiqc commit 264fd61d39f252ebb81731bf6cd3349fdb39b306
iuc
parents:
diff changeset
23 Support new modules
3bad335ccea9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/multiqc commit 264fd61d39f252ebb81731bf6cd3349fdb39b306
iuc
parents:
diff changeset
24 -------------------
3bad335ccea9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/multiqc commit 264fd61d39f252ebb81731bf6cd3349fdb39b306
iuc
parents:
diff changeset
25
3bad335ccea9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/multiqc commit 264fd61d39f252ebb81731bf6cd3349fdb39b306
iuc
parents:
diff changeset
26 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
27 To add new ones, you can look at the patterns at https://github.com/ewels/MultiQC/blob/master/multiqc/utils/search_patterns.yaml