R/Pearce1984.R

In pvermees/GeoplotR: Toolbox for Geological Plots

#' @title Pearce et al. (1984)
#' @name Pearce1984
#' @rdname Pearce1984
#' @description tectonic discrimination diagram for granites
#' @param Y vector with Y concentrations (ppm)
#' @param Nb vector with Nb concentrations (ppm)
#' @param Yb vector with Yb concentrations (ppm)
#' @param Ta vector with Ta concentrations (ppm)
#' @param Rb vector with Rb concentrations (ppm)
#' @param xlim x-axis limits
#' @param ylim y-axis limits
#' @param show.labels logical. If \code{TRUE}, labels the polygonal
#'     fields with their respective tectonic affinities.
#' @param ... additional arguments to the generic \code{points}
#'     function.
#' @references Pearce, J. A., Harris, N. B. W., and Tindle, A. G.,
#'     1984,
#'     "Trace Element Discrimination Diagrams for the Tectonic Interpretation of Granitic Rocks":
#'     Journal of Petrology, v. 25, no. 4, p. 956-983.
#' @examples
#' data(test,package='GeoplotR')
#' @return a vector with tectonic affinities
NULL

#' @rdname Pearce1984
#' @examples
#' YNb(Y=test[,'Y'],Nb=test[,'Nb'])
#' @export
YNb <- function(Y=NULL,Nb=NULL,show.labels=TRUE,
                xlim=NULL,ylim=NULL,...){
    if (is.null(xlim)) xlim <- getlimits(x=Y,m=1,M=1000)
    if (is.null(ylim)) ylim <- getlimits(x=Nb,m=1,M=1000)
    invisible(xyplot(json=.YNb,X=Y,Y=Nb,show.labels=show.labels,
                     xlim=xlim,ylim=ylim,xlab='Y (ppm)',
                     ylab='Nb (ppm)',log='xy',...))
}

#' @rdname Pearce1984
#' @examples
#' YNbRb(Y=test[,'Y'],Nb=test[,'Nb'],Rb=test[,'Rb'])
#' @export
YNbRb <- function(Y=NULL,Nb=NULL,Rb=NULL,show.labels=TRUE,
                  xlim=NULL,ylim=NULL,...){
    if (is.null(xlim)) xlim <- getlimits(x=Y+Nb,m=1,M=1000)
    if (is.null(ylim)) ylim <- getlimits(x=Rb,m=1,M=1000)
    invisible(xyplot(json=.YNbRb,X=Y+Nb,Y=Rb,show.labels=show.labels,
                     xlim=xlim,ylim=ylim,xlab='(Y + Nb)(ppm)',
                     ylab='Rb (ppm)',log='xy',...))    
}

#' @rdname Pearce1984
#' @examples
#' YbTa(Yb=test[,'Yb'],Ta=test[,'Ta'])
#' @export
YbTa <- function(Yb=NULL,Ta=NULL,xlim=NULL,ylim=NULL,show.labels=TRUE,...){
    if (is.null(xlim)) xlim <- getlimits(x=Yb,m=0.1,M=100)
    if (is.null(ylim)) ylim <- getlimits(x=Ta,m=0.05,M=100)
    invisible(xyplot(json=.YbTa,X=Yb,Y=Ta,show.labels=show.labels,
                     xlim=xlim,ylim=ylim,xlab='Yb (ppm)',
                     ylab='Ta (ppm)',log='xy',...))
}

#' @rdname Pearce1984
#' @examples
#' YbTaRb(Yb=test[,'Yb'],Ta=test[,'Ta'],Rb=test[,'Rb'])
#' @export
YbTaRb <- function(Yb=NULL,Ta=NULL,Rb=NULL,show.labels=TRUE,
                   xlim=NULL,ylim=NULL,...){
    if (is.null(xlim)) xlim <- getlimits(x=Yb+Ta,m=0.9,M=110)
    if (is.null(ylim)) ylim <- getlimits(x=Rb,m=1,M=1000)
    invisible(xyplot(json=.YbTaRb,X=Yb+Ta,Y=Rb,show.labels=show.labels,
                     xlim=xlim,ylim=ylim,xlab='(Yb + Ta)(ppm)',
                     ylab='Rb (ppm)',log='xy',...))    
}