1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
|
.. include:: ../../global.inc
.. include:: manual_chapter_numbers.inc
.. index::
pair: flowchart colours; Tutorial
.. _new_manual.flowchart_colours:
##########################################################################################################################################################################################################################################
|new_manual.flowchart_colours.chapter_num|: Flow Chart Colours with :ref:`pipeline_printout_graph(...) <pipeline_functions.pipeline_printout_graph>`
##########################################################################################################################################################################################################################################
.. seealso::
* :ref:`Manual Table of Contents <new_manual.table_of_contents>`
* :ref:`pipeline_printout_graph(...) <pipeline_functions.pipeline_printout_graph>`
* :download:`Download code <../../static_data/example_scripts/play_with_colours.py>`
* :ref:`Code <new_manual.flowchart_colours.code>` for experimenting with colours
******************
Flowchart colours
******************
The appearance of *Ruffus* flowcharts produced by :ref:`pipeline_printout_graph <pipeline_functions.pipeline_printout_graph>`
can be extensively customised.
This is mainly controlled by the :ref:`user_colour_scheme <pipeline_functions.pipeline_printout_graph.user_colour_scheme>` (note UK spelling of "colour") parameter
Example:
Use colour scheme index = 1
::
pipeline_printout_graph ("flowchart.svg", "svg", [final_task],
user_colour_scheme = {
"colour_scheme_index" :1,
"Pipeline" :{"fontcolor" : '"#FF3232"' },
"Key" :{"fontcolor" : "Red",
"fillcolor" : '"#F6F4F4"' },
"Task to run" :{"linecolor" : '"#0044A0"' },
"Final target" :{"fillcolor" : '"#EFA03B"',
"fontcolor" : "black",
"dashed" : 0 }
})
There are 8 colour schemes by setting ``"colour_scheme_index"``:
::
pipeline_printout_graph ("flowchart.svg", "svg", [final_task],
user_colour_scheme = {"colour_scheme_index" :6})
These colours were chosen after much fierce arguments between the authors and friends, and much
inspiration from http://kuler.adobe.com/#create/fromacolor. Please
feel free to submit any additional sets of colours for our consideration.
(Click here for image in :download:`svg <../../images/flowchart_colour_schemes.svg>`.)
.. image:: ../../images/flowchart_colour_schemes.png
|
