addPiper: Add Detail to a Piper Plot

View source: R/addPiper.R

addPiperR Documentation

Add Detail to a Piper Plot

Description

Adds points or lines to a Piper plot.

Usage

addPiper(xCat, yCat, zCat, xAn, yAn, zAn, xPip, yPip, Plot = list(name =
  "", what = "points", type = "solid", width = "standard", symbol =
  "circle", filled = TRUE, size = 0.09, color = "black"),
  current = list())

Arguments

xCat

,

yCat

, and

zCat

the cations for the x-, y-, and z-axes. Need not sum to 1 or 100. See Details.

xAn

,

yAn

, and

zAn

the anions for the x-, y-, and z-axes. Need not sum to 1 or 100. See Details.

xPip

, and

yPip

the coordinates for the internal piper diagram. See Details.

Plot

parameters defining the characteristics of the plot. See setPlot for a description of the parameters.

current

the current plot information. Typically, this would be the output from one of the graph creation functions like piperPlot.

Details

The values for xCat, yCat, zCat, xAn, yAn, and zAn should match the constituents in the original call to piperPlot. The units should be in milli-equivalents if all three components are used to add to the Piper plot.

There are two ways to add to a Piper plot, the first way is to specify new data by supplying values for xCat, yCat, zCat, xAn, yAn, and zAn. In this case the data for the central middle (Piper) plot are generated from those data and the xPip, yPip arguments will be ignored. The other way is to use processed values from an already created Piper plot to add details to the plot, either customized symbols or closed lines showing groups for example. The vignette PiperPlot shows an example of customized symbols.

Value

Information about the graph.

See Also

piperPlot

Examples

## Not run: 
# See for examples of addPiper:
vignette(topic="PiperPlot", package="smwrGraphs")

## End(Not run)

USGS-R/smwrGraphs documentation built on Oct. 11, 2022, 6:11 a.m.