SCMatrix: Construct the Stratigraphic Constrain Matrix Interactively

View source: R/SCMatrix.R

SCMatrixR Documentation

Construct the Stratigraphic Constrain Matrix Interactively

Description

This function helps to define the stratigraphic relation between samples using questions. The output of this function can be used in the function AgeS_Computation.

Usage

SCMatrix(DATA = NULL, Nb_sample, SampleNames)

Arguments

DATA

BayLum.list (with default): Object of class BayLum.list, if provided the other parameters are not any longer mandatory.

Nb_sample

integer (required): the sample number, if DATA is provided, the input is not required

SampleNames

character (required): sample names, if DATA is provided, the input is not required

Details

The function will ask if sample i is younger than sample j to construct the stratigraphic constrain matrix.

Value

Returns a matrix that summarise the ordered relation between samples. This matrix can be integrate in AgeS_Computation function. We refer to detail on AgeS_Computation for more information concerning this matrix.

How to cite

Christophe, C., Philippe, A., Guérin, G., Kreutzer, S., 2024. SCMatrix(): Construct the Stratigraphic Constrain Matrix Interactively. In: Christophe, C., Philippe, A., Kreutzer, S., Guérin, G., Baumgarten, F.H., Frerebeau, N., 2024. BayLum: Chronological Bayesian Models Integrating Optically Stimulated. R package version 0.3.2. https://CRAN.r-project.org/package=BayLum

Author(s)

Claire Christophe, Anne Philippe, Guillaume Guérin, Sebastian Kreutzer

See Also

AgeS_Computation

Examples

## Not run: 
SCMatrix(
 Nb_sample = 2,
 SampleNames = c("sample1","sample2"))

## End(Not run)


R-Lum/BayLum documentation built on April 19, 2024, 9:33 a.m.