Skip to content

Commit cfbce33

Browse files
committed
Docs philosophy: Colours
1 parent 8362a67 commit cfbce33

File tree

1 file changed

+17
-0
lines changed

1 file changed

+17
-0
lines changed

docs/modules.md

+17
Original file line numberDiff line numberDiff line change
@@ -53,6 +53,23 @@ This is problematic for two reasons:
5353

5454
It's usually better to copy and paste a bit in these cases. The code is then easier to understand and easier to customise.
5555

56+
### Colour matters
57+
58+
The emphasis for MultiQC reports is to allow people to quickly scan and spot outlier samples.
59+
The core of this is data visualisation.
60+
61+
Especially when creating tables, make sure that you think about the [colour scheme](#table-colour-scales-1) for every single column.
62+
63+
- Ensure that adjacent columns do not share the same colour scheme
64+
- Makes long tables easier to follow
65+
- Allows fast recognition of columns for regular users
66+
- Think about what the colours suggest
67+
- For example, if a large value is a _bad_ thing (eg. percent duplication), use a strong red colour for large values
68+
- If values are centred around a point (eg. `0`), use a diverging colour scheme. Values close to the centre will have a weak colour and those at _both_ ends of the distribution will be strongly coloured.
69+
- This allows rapid understanding without a lot of thought
70+
71+
This usually comes up for tables, but you can also think about it for bar plots.
72+
5673
## Core modules / plugins
5774

5875
New modules can either be written as part of MultiQC or in a stand-alone

0 commit comments

Comments
 (0)