Skip to contents

Plots Lx/Tx as a function of the regenerative dose (DEPRECATED)

Source: R/LT_RegenDose.R
LT_RegenDose-deprecated.Rd

This function plots Lx/Tx values as a function of regenerative dose, for every selected aliquot and for each sample.

Usage

LT_RegenDose(
  DATA,
  Path,
  FolderNames,
  SampleNames = FolderNames,
  Nb_sample,
  BinPerSample = rep(1, Nb_sample),
  SG = rep(TRUE, Nb_sample),
  sepDP = c(","),
  nrow = 3L,
  ncol = nrow
)

Arguments

DATA

list (required): list of objects LT, sLT, ITimes, dLab, ddot_env, regDose, J, K, Nb_measurement, #' provided by Generate_DataFile or Generate_DataFile_MG or combine_DataFiles.DATA can contain information from more than one sample.

Path

character (required): path to the project folder (the same as the one used in Generate_DataFile or Generate_DataFile_MG to provide DATA)

FolderNames

character (required): vector of names of the sub-folders containing the BIN-files, which were used by Generate_DataFile or Generate_DataFile_MG to generate the DATA object.

SampleNames

character (with default): Names of samples. To use if there is more than one bin file per sample.

Nb_sample

integer (required): ID number (in [1,Nb_sample]) of the sample selected for plotting L/T as a function of regenerative doses. Required if the DATA object contains information for more than one sample.

BinPerSample

integer (with default): integer vector (with default): vector with the number of BIN files per sample, which was used in Generate_DataFile or Generate_DataFile_MG to generate the DATA object.

SG

logical (with default): vector to set the type of measurement for each sample length(SG)=Nb_sample.If the sample of number ID equal to i, SG[i]=TRUE if it is a Single-grain OSL measurements, SG[i]=FALSE if it is a Multi-grain OSL measurements.

sepDP

character (with default): column separator in the DiscPos.csv file or in Disc.csv file. It must be the same separator for all samples, for single-grain OSL measurements or multi-grain OSL measurements.

nrow

integer (with default): controls the arrangement of the plots, here the number of rows. Can be set to NULL.

ncol

integer (with default): controls the arrangement of the plots, here the number of columns. Can be set to NULL.

Value

Lx/Tx plots; there are as many plots as selected aliquots in the DiscPos.csv file. There are 9 plots per page. There is not interpolation.

Details

To fill FolderNames and BinPerSample, we refer to the Detail section from the Generate_DataFile or Generate_DataFile_MG function. As well for a precise description of input DATA.

See also

Generate_DataFile, Generate_DataFile_MG

Author

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

How to cite

Christophe, C., Kreutzer, S., Philippe, A., Guérin, G., 2024. LT_RegenDose-deprecated(): Plots Lx/Tx as a function of the regenerative dose (DEPRECATED). 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.3.9000-13. https://CRAN.r-project.org/package=BayLum

Examples

if (FALSE) { # \dontrun{
## load data file generated by the function Generate_DataFile
data(DATA3,envir = environment())
path<- system.file("extdata/FER1", "", package="BayLum")
folder=""
samplename <- "FER1"
LT_RegenDose(
 DATA = DATA3,
 Path = path,
 FolderNames = folder,
 SampleNames = samplename,
 Nb_sample = 1,
 SG = FALSE)
} # }