util.plot: Functions to Create and Modify Plots

Description Usage Arguments Details

Description

Initialize a new plot window using preset parameters, add an axis or title to a plot, generate labels for axes and subplots, add stability lines for water, get colors for a set of numeric values.

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
  thermo.plot.new(xlim, ylim, xlab, ylab, cex = par("cex"),
    mar = NULL, lwd = par("lwd"), side = c(1,2,3,4), 
    mgp = c(1.7, 0.3, 0), cex.axis = par("cex"), col = par("col"),
    yline = NULL, axs = "i", do.box = TRUE, las = 1,
    xline = NULL, ...)
  label.plot(x, xfrac = 0.05, yfrac = 0.95, paren = FALSE,
    italic = FALSE, ...)
  usrfig()
  label.figure(x, xfrac = 0.05, yfrac = 0.95, paren = FALSE,
    italic = FALSE, ...)
  water.lines(eout, which = c("oxidation","reduction"),
    lty = 2, lwd=1, col = par("fg"), plot.it = TRUE)
  mtitle(main, line=0, spacing=1, ...)
  ZC.col(z)

Arguments

xlim

numeric, limits of the x-axis

ylim

numeric, limits of the y-axis

xlab

character, x-axis label

ylab

character, y-axis label

cex

numeric, character expansion factor for labels

mar

numeric, width (number of lines) of margins on each side of plot

lwd

numeric, line width

side

numeric, which sides of plot to draw axes

mgp

numeric, sizes of margins of plot

cex.axis

numeric, character expansion factor for names of axes

col

character, line color

yline

numeric, margin line on which to plot y-axis name

axs

character, setting for axis limit calculation

do.box

logical, draw a box around the plot?

las

numeric, style for axis labels

xline

numeric, margin line on which to plot x-axis name

...

further arguments passed to par or mtext

x

character, label to place on plot

xfrac

numeric, fractional location on x-axis for placement of label

yfrac

numeric, fractional location on y-axis for placement of label

paren

logical, add parentheses around label text?

italic

logical, italicize label text?

eout

data frame, output of affinity, equilibrate, or diagram

which

character, which of oxidation/reduction lines to plot

lty

numeric, line type

plot.it

logical, plot the lines?

main

character, text for plot title

line

numeric, margin line to place title

spacing

numeric, spacing between multiple lines

z

numeric, set of values

Details

thermo.plot.new sets parameters for a new plot, creates a new plot using plot.new, and adds axes and major and minor tick marks to the plot. Plot parameters (see par) including cex, mar, lwd, mgp and axs can be given, as well as a numeric vector in side identifying which sides of the plot receive tick marks. yline, if present, denotes the margin line (default par('mgp')[1]) where the y-axis name is plotted.

water.lines plots lines representing the oxidation and reduction stability limits of water on Eh/pe/\logfO2/\logfH2 vs pH/\T/\P diagrams. The x- and y-variables and their ranges are taken from eout. Values of \T, \P, pH, and \logaH2O, not corresponding to either axis, are also taken from eout. which controls which lines are drawn (oxidation, reduction, or both (the default)). The value of swapped in the output reflects whether pH, \T, or \P is on the x-axis (TRUE) or y-axis (FALSE). NA is returned for any diagram for variables that can not be processed (including diagrams with more than 2 variables).

label.plot and label.figure add identifying text within the plot region and figure region. The value given for x is made into a label, optionally italicized and with parentheses (like (a)). The location of the label is controlled by xfrac and yfrac (the fractional coordinates of either the plot or figure region), and ... can include other parameters such as cex and adj that are passed to text.

usrfig returns the limits of the figure region in “user” coordinates (i.e. the limits of the plot region, from par("usr")). It is a supporting function for label.figure but is also useful for other circumstances where information must be added at a particular location in a figure.

mtitle can be used to add a multi-line title to a plot. It loops over each element of main and places it on a separate margin line using mtext. The spacing of the last (bottom) line from the edge of the plot is specified by line. This function exists to facilitate using expressions in multiline titles (see revisit for an example.)

ZC.col uses colorspace) to generate colors from a diverging palette (red - light grey - blue) corresponding to the values in z. Red is associated with lower values of z. This function is intended to generate colors for distinguishing average oxidation state of carbon ZC, but any numeric values can be supplied.


CHNOSZ documentation built on Oct. 11, 2017, 3:01 a.m.