Learn R Programming

⚠️There's a newer version (4.4) of this package.Take me there.

provenance

provenance bundles a number of established statistical methods to facilitate the visual interpretation of large datasets in sedimentary geology. Includes functionality for adaptive kernel density estimation, principal component analysis, correspondence analysis, multidimensional scaling, generalised procrustes analysis and individual differences scaling using a variety of dissimilarity measures. Univariate provenance proxies, such as single-grain ages or (isotopic) compositions are compared with the Kolmogorov-Smirnov, Kuiper or Sircombe-Hazelton L2 distances. Categorical provenance proxies such as chemical compositions are compared with the Aitchison and Bray-Curtis distances, and point-counting data with the chi-square distance. Also included are tools to plot compositional and point-counting data on ternary diagrams and point-counting data on radial plots, to calculate the sample size required for specified levels of statistical precision, and to assess the effects of hydraulic sorting on detrital compositions. Includes an intuitive query-based user interface for users who are not proficient in R..

Prerequisites

You must have R installed on your system (see https://www.r-project.org). Additionally, to install provenance from Github, you also need the devtools package. This can be installed by typing the following code at the R command line prompt:

install.packages('devtools')

Installation

The most recent stable version of provenance is available from CRAN at https://cran.r-project.org/package=provenance and can be installed on your system as follows:

install.packages('provenance')

Alternatively, to install the current development version of provenance from Github, type:

library(devtools)
install_github('pvermees/provenance')

Further information

See https://www.ucl.ac.uk/~ucfbpve/provenance/

Vermeesch, P., Resentini, A. and Garzanti, E., 2016, An R package for statistical provenance analysis, Sedimentary Geology, 336, 14-25

Vermeesch, P., 2018, Statistical models for point-counting data. Earth and Planetary Science Letters 501, 1-7

Author

Pieter Vermeesch

License

This project is licensed under the GPL-3 License

Copy Link

Version

Install

install.packages('provenance')

Monthly Downloads

207

Version

4.1

License

GPL-2

Maintainer

Pieter Vermeesch

Last Published

March 3rd, 2023

Functions in provenance (4.1)

amalgamate

Group components of a composition
as.acomp

create an acomp object
densities

A list of rock and mineral densities
Wasserstein.diss

Wasserstein distance
get.n

Calculate the number of grains required to achieve a desired level of sampling resolution
get.p

Calculate the probability of missing a given population fraction
minsorting

Assess settling equivalence of detrital components
plot.CA

Point-counting biplot
botev

Compute the optimal kernel bandwidth
bray.diss

Bray-Curtis dissimilarity
endmembers

Petrographic end-member compositions
get.f

Calculate the largest fraction that is likely to be missed
plot.GPA

Plot a Procrustes configuration
plot.INDSCAL

Plot an INDSCAL group configuration and source weights
radialplot

Visualise point-counting data on a radial plot
provenance

Menu-based interface for provenance
plot.KDE

Plot a kernel density estimate
combine

Combine samples of distributional data
plot.KDEs

Plot one or more kernel density estimates
central

Calculate central compositions
plot.compositional

Plot a pie chart
read.varietal

Read a .csv file with varietal data
points.ternary

Ternary point plotting
procrustes

Generalised Procrustes Analysis of provenance data
restore

Undo the effect of hydraulic sorting
read.distributional

Read a .csv file with distributional data
read.densities

Read a .csv file with mineral and rock densities
read.compositional

Read a .csv file with compositional data
plot.PCA

Compositional biplot
diss

Calculate the dissimilarity matrix between two datasets of class distributional, compositional, counts or varietal
plot.minsorting

Plot inferred grain size distributions
plot.ternary

Plot a ternary diagram
summaryplot

Joint plot of several provenance datasets
lines.ternary

Ternary line plotting
indscal

Individual Differences Scaling of provenance data
ternary

Define a ternary composition
plot.MDS

Plot an MDS configuration
read.counts

Read a .csv file with point-counting data
text.ternary

Ternary text plotting
subset

Get a subset of provenance data
plot.distributional

Plot continuous data as histograms or cumulative age distributions
ternary.ellipse

Ternary confidence ellipse
varietal2distributional

Convert varietal to distributional data
KS.diss

Kolmogorov-Smirnov dissimilarity
GPA

Generalised Procrustes Analysis of configurations
KDE

Create a kernel density estimate
CLR

Centred logratio transformation
CA

Correspondence Analysis
ALR

Additive logratio transformation
Kuiper.diss

Kuiper dissimilarity
MDS

Multidimensional Scaling
Namib

An example dataset
KDEs

Generate an object of class KDEs
as.data.frame

create a data.frame object
SNSM

varietal data example
as.varietal

create a varietal object
as.compositional

create a compositional object
as.counts

create a counts object
PCA

Principal Component Analysis
SH.diss

Sircombe and Hazelton distance