Skip to contents

Convert Risoe.BINfileData object to an RLum.Analysis object

Source: R/Risoe.BINfileData2RLum.Analysis.R
Risoe.BINfileData2RLum.Analysis.Rd

Converts values from one specific position of a Risoe.BINfileData S4-class object to an RLum.Analysis object.

Usage

Risoe.BINfileData2RLum.Analysis(
  object,
  pos = NULL,
  grain = NULL,
  run = NULL,
  set = NULL,
  ltype = NULL,
  dtype = NULL,
  protocol = "unknown",
  keep.empty = TRUE,
  txtProgressBar = FALSE
)

Arguments

object

Risoe.BINfileData (required): Risoe.BINfileData object

pos

numeric (optional): position number of the Risoe.BINfileData object for which the curves are stored in the RLum.Analysis object. If length(position)>1 a list of RLum.Analysis objects is returned. If nothing is provided every position will be converted. If the position is not valid NULL is returned.

grain

vector, numeric (optional): grain number from the measurement to limit the converted data set (e.g., grain = c(1:48)). Please be aware that this option may lead to unwanted effects, as the output is strictly limited to the chosen grain number for all position numbers

run

vector, numeric (optional): run number from the measurement to limit the converted data set (e.g., run = c(1:48)).

set

vector, numeric (optional): set number from the measurement to limit the converted data set (e.g., set = c(1:48)).

ltype

vector, character (optional): curve type to limit the converted data. Commonly allowed values are: IRSL, OSL, TL, RIR, RBR and USER (see also Risoe.BINfileData)

dtype

vector, character (optional): data type to limit the converted data. Commonly allowed values are listed in Risoe.BINfileData

protocol

character (optional): sets protocol type for analysis object. Value may be used by subsequent analysis functions.

keep.empty

logical (with default): If TRUE (default) an RLum.Analysis object is returned even if it does not contain any records. Set to FALSE to discard all empty objects.

txtProgressBar

logical (with default): enables or disables txtProgressBar.

Value

Returns an RLum.Analysis object.

Details

The RLum.Analysis object requires a set of curves for specific further protocol analyses. However, the Risoe.BINfileData usually contains a set of curves for different aliquots and different protocol types that may be mixed up. Therefore, a conversion is needed.

Note

The protocol argument of the RLum.Analysis object is set to 'unknown' if not stated otherwise.

Function version

0.4.3

See also

Risoe.BINfileData, RLum.Analysis, read_BIN2R

Author

Sebastian Kreutzer, Institute of Geography, Heidelberg University (Germany) , RLum Developer Team

How to cite

Kreutzer, S., 2024. Risoe.BINfileData2RLum.Analysis(): Convert Risoe.BINfileData object to an RLum.Analysis object. Function version 0.4.3. In: Kreutzer, S., Burow, C., Dietze, M., Fuchs, M.C., Schmidt, C., Fischer, M., Friedrich, J., Mercier, N., Philippe, A., Riedesel, S., Autzen, M., Mittelstrass, D., Gray, H.J., Galharret, J., Colombo, M., 2024. Luminescence: Comprehensive Luminescence Dating Data Analysis. R package version 0.9.26. https://r-lum.github.io/Luminescence/

Examples


##load data
data(ExampleData.BINfileData, envir = environment())

##convert values for position 1
Risoe.BINfileData2RLum.Analysis(CWOSL.SAR.Data, pos = 1)