Get or set default parameters for the package. Notice changes done to the parameter values are reset everytime the R session is closed and the package is reloaded.
1 2 3 4 
par 
Three possible cases:

reset 
Single logical. If TRUE, all the parameters will be set to their default value. Values are reset before any change to the parameter values, as listed below. 
testRange 
Single logical. Test if the range of fraction is between 0 and the expected sum of fractions (1 or 100). 
testSum 
Single logical. Test if the sum of the 3 fractions is equal to the expected sum of fractions (1 or 100). 
fracSumTol 
Single numeric. Tolerance on the sum of the 3 ternary fractions. Overall
tolerance is 
vertices 
Vertices of a ternary classification (default): a

classes 
Polygons (classes outline) of a ternary classification (default):
a 
scale 
Scaleextent of a ternary classification (default): a

okClock 
A list of vectors of 3 logical values, with the valid

sp 
Single logical value. If 
onFailure 
R 
ticksAt 
Vector of numeric. Predefined position of the tickmarks for the 3 axis. Between 0 and 'fracSum' (the sum of the 3 fractions). 
ticksShift 
Single numeric. Tickmarks 'size', expressed so that

arrowsShift 
Vector of two numeric values. Axis' arrows' shift from their
axis, expressed so that 
arrowsHeight 
Single numeric values. Axis' arrows' height (distance
between the 1st part of the arrow and the 2nd part of the
arrow), expressed in fraction of marginlinesheight
(same as 
arrowsCoords 
Parameters used internally to define axisarrows location 
arrowsBreak 
Single logical value. If 
grid.line.col 
Single character value representing a color. Color of the gridlines added to a ternary plot. 
axis.line.lwd 
Single numerical value. Line thickness for the axislines (including ticks and arrows) 
plot.bg 
Single character value representing a color. Fillcolor of the
plot region (frame). Set to 
The function has 3 possible, nonexclusive behaviours:
If
reset=TRUE
, resetting the parameters to their initial values, as
defined in this function.
(Silently) returning the actual value of the
package parameters. If par=NULL
, all the values are returned. If
par
is a vector of parameter names, their value will be returned.
Settingup the value of some parameters, passing a list of parameter
value to par
OR setting some of the parameters listed above.
Notice that when reset=TRUE
and some new parameter values are
provided, the parameters are first reset, and then the new parameter values
are set. If par
is a list, parameters are set first according to
values in par
, and then according to values in the parameters listed
below. This combination is not recommended, but nonetheless possible.
The actual value of the parameters is stored in (and can be retrieved from)
the environment rspPars
. The default value of the parameters are
stored in the environment rspPars
. Do not use them directly.
Returns a partial or complete list of (actual) parameter values, as a named list.
Questions? Problems? Suggestions? Tweet to @rdrrHQ or email at ian@mutexlabs.com.
Please suggest features or report bugs with the GitHub issue tracker.
All documentation is copyright its authors; we didn't write any of that.