1. Home
  2. FHEATCOLOURS procedure

FHEATCOLOURS procedure

Forms colours from the values in a variate to use in a heatmap (R.W. Payne).

Options

START = scalars or texts Initial colour for each band; must be set
END = scalars or texts Final colours for each band; must be set

Parameters

VARIATE = variates Values to define the colours
COLOURS = variates Saves the colours, as RGB values, calculated for each VARIATE
MINIMUM = scalars Value to use for START; default uses the minimum value of the VARIATE
MAXIMUM =  scalars Value to use for END; default uses the maximum value of the VARIATE

Description

FHEATCOLOURS forms colours from the values in a variate, which can be used for a heatmap plotted by the DHEATMAP procedure. The variate must be specified by the VARIATE parameter, and the colours can be saved, as RGB values, in a variate specified by the COLOURS parameter.

The START option defines the initial COLOUR, in a scalar containing an RGB value, or in a text containing the name of one of the standard colours. (See the PEN directive for details.) The corresponding initial value for the VARIATE is specified by the MINIMUM parameter. If this is not set, the default is to use the minimum value of the VARIATE. Similarly, the END option defines the final colour, and the corresponding final value for the VARIATE is specified by the MAXIMUM parameter (with a default of the maximum value of the VARIATE).

Options: START, END

Parameters: VARIATE, COLOURS , MINIMUM, MAXIMUM 

See also

Directives: PEN

Procedures: DBANDCOLOURS  DCOLOURS DHEATMAP DDESIGN

GenStat Reference Manual 1 Summary section on: Graphics

Example

CAPTION   'FHEATCOLOURS example'; STYLE=meta
SPLOAD       '%data%/Canola.gsh'
" calculate colours from blue to red for yield "
FHEATCOLOURS [START='blue'; END='red'] yield; COLOURS=heat; MINIMUM=0; MAXIMUM=2
PRINT        yield,heat
" plot the colours for yield "
SORT         yield,heat
MATRIX       [ROWS=yield; COLUMNS=1] heatmat; VALUES=heat
XAXIS        1; ACTION=hide
YAXIS        1; TITLE='yield'
DBITMAP      [YORIENTATION=reverse] heatmat

Updated on April 15, 2024

Was this article helpful?