R/documentation.R

In pvermees/simplex: Data Reduction Software for Secondary Ion Mass Spectrometry

#' @title test data
#'
#' @description Various Cameca and SHRIMP datasets
#' @name test-data
#' @keywords datasets
"Cameca_UPb"
#' @rdname test-data
"Cameca_UThPb"
#' @rdname test-data
"Cameca_oxygen"
#' @rdname test-data
"Cameca_sulphur"
#' @rdname test-data
"SHRIMP_UPb"

#' simplex: a SIMS data reduction package
#'
#' \code{simplex} is a data reduction package for Secondary Ion Mass
#' Spectrometry (SIMS), with functionality for both stable isotope
#' geochemistry and U-(Th)-Pb geochronology. The package accommodates
#' data from both Cameca and SHRIMP instruments. All mathematical
#' operations take place in logratio space (aka the simplex) to ensure
#' positivity and keep track of correlated uncertainties.
#'
#' A list of documented functions may be viewed by typing
#' \code{help(package='simplex')}.  Source code and further
#' instructions are provided at
#' \url{https://github.com/pvermees/simplex/}.
#' 
#' @name simplex
#' @docType package
#' @aliases simplex-package
"_PACKAGE"
#> [1] "_PACKAGE"