Taylor Diagram Options - PeterRochford/SkillMetrics GitHub Wiki

An exhaustive list of options is available to customize the appearance of the Taylor diagram and are listed below for convenience of reference. The format for their use is "option = value". For example, to produce a Taylor diagram that also shows the observational standard deviation, the command would appear as (cf. taylor2.py)

sm.taylor_diagram(sdev,crmsd,ccoef, styleOBS = '-', colOBS = 'r', markerobs = 'o', titleOBS = 'observation')

These options can also be obtained by calling the taylor_diagram function without arguments at a Python command line:

% python

>>> import skill_metrics as sm

>>> sm.taylor_diagram()

General Options

alpha	Blending of symbol face color (0.0 transparent through 1.0 opaque) (Default: 1.0)
axisMax	Maximum for the radial contours
colFrame	Color for the y and x spines
colorMap	'on' / 'off' (default): Switch to map color shading of markers to colormap ("on") or min to max range of RMSDz values ("off"). Set to same value as option "nonRMSDz".
labelWeight	Weight of the x & y axis labels
numberPanels	1 or 2: Panels to display (1 for positive correlations, 2 for positive and negative correlations). Default value depends on correlations (CORs).
overlay	'on' / 'off' (default): Switch to overlay current statistics on Taylor diagram. Only markers will be displayed.

Options when ColorMap is 'on'

cmap	Choice of colormap. (Default: 'jet')
cmap_marker	Marker to use with colormap (Default: 'd')
cmap_vmax	Maximum range of colormap (Default: None)
cmap_vmin	Minimum range of colormap (Default: None)

Marker Options

MarkerDisplayed	'marker' (default): Experiments are represented by individual symbols
	'colorBar': Experiments are represented by a color described in a colorbar

Options when MarkerDisplayed is 'marker'

markerColor	Single color to use for all markers
markerColors	Dictionary with up to two colors as keys ('face', 'edge') to use for all markers when 'markerlegend' == 'off' or None. If None or 'markerlegend' == 'on', then uses only the value of 'markercolor'. (Default: None)
markerLabel	Labels for markers
markerLabelColor	Marker label color (Default: black)
markerLayout	Matrix layout for markers in legend [nrow, ncolumn], e.g. [4,None] for 4 rows and [None,3] for 3 columns. (Default [15, no. markers/15] )
markerLegend	'on' / 'off' (default): Use legend for markers
markers	Dictionary providing individual control of the marker label, label color, symbol, size, face color, and edge color (Default: None)
markerSize	Marker size (Default: 10)
markerSymbol	Marker symbol (Default: 'o')

Options when MarkerDisplayed is 'colorbar'

cmapZData	Data values to use for color mapping of markers, e.g. RMSD or BIAS (Default empty). Used to make range of values appear beside color bar.
locationColorBar	Location for the colorbar, 'NorthOutside' or 'EastOutside'.
titleColorBar	Title of the colorbar

RMS Axis Options

colRMS	RMS grid and tick labels color. (Default: green)
labelRMS	RMS axis label (Default: 'RMSD')
rincRMS	Axis tick increment for RMS values
rmsLabelFormat	String format for RMS contour labels, e.g. '0:.2f'. (Default '0', format as specified by str function.)
showlabelsRMS	'on' / 'off' (default): Show the RMS tick labels
styleRMS	Line style of the RMS grid
tickRMS	RMS values to plot gridding circles from observation point
tickRMSangle	Angle for RMS tick labels with the observation point. (Default: 135 deg.)
titleRMS	'on' / 'off' (default): Show RMSD axis title
titleRMSDangle	Angle at which to display the 'RMSD' label for the RMS contours (Default: 160 degrees)
widthRMS	Line width of the RMS grid

STD Axis Options

colSTD	STD grid and tick labels color. (Default: black)
colsSTD	STD dictionary of grid colors with: 'grid', 'tick_labels', 'title' keys/values. If not provided or None, considers the monotonic 'colSTD' argument. ("Default: None")
rincSTD	Axis tick increment for STD values
showlabelsSTD	'on' / 'off' (default): Show the STD tick labels
styleSTD	Line style of the STD grid
tickSTD	STD values to plot gridding circles from observation point
titleSTD	'on' / 'off' (default): Show STD axis title
widthSTD	Line width of the STD grid

Correlation Axis Options

colCOR	CORRELATION grid color. (Default: blue)
colsCOR	CORRELATION dictionary of grid colors with: 'grid', 'tick_labels', 'title' keys/values. If not provided or None, considers the monotonic 'colSTD' argument. ("Default: None")
showlabelsCOR	'on' (default) / 'off': Show the CORRELATION tick labels
styleCOR	Line style of the CORRELATION grid
tickCOR[panel]	Tick values for correlation coefficients for two types of panelsCOR grid values
titleCOR	'on' / 'off' (default): Show CORRELATION axis title
titleCORshape	The shape of the label 'correlation coefficient'. Accepted values are 'curved' or 'linear'. (Default: 'curved')
widthCOR	Line width of the COR grid

Observation Point Options

colOBS	Observation STD color. (Default: magenta)
markerObs	Marker to use for x-axis indicating observed STD.A choice of 'None' will suppress appearance of marker. (Default None)
styleOBS	Line style for observation grid line. A choice of empty string ('') will suppress appearance of the grid line. (Default: '')
titleOBS	Label for observation STD point on axis
widthOBS	Line width of the observation STD circle

Control Options

checkStats	'on' / 'off' (default): Check input statistics satisfy Taylor relationship

Plotting Options from File

taylor_options_file	name of CSV file containing values for optional arguments of the taylor_diagram function. If no file suffix is given a '.csv' is assumed. (Default: empty string '')