structure_RLum: General structure function for RLum-class objects

Description

The function provides a generalised access point for specific RLum objects. Depending on the input object, the corresponding function will be selected.

Usage

structure_RLum(object, ...)
# S4 method for list
structure_RLum(object, ...)
# S4 method for RLum.Analysis
structure_RLum(object, fullExtent = FALSE)

Value

Returns a data.frame with structure of the object.

Arguments

object: RLum (required): S4 object of class RLum
...: further arguments passed to the specific class method
fullExtent: logical (with default): extends the returned data.frame to its full extent, i.e. all info elements are part of the return as well. The default value is FALSE as the data frame might become rather big.

Functions

structure_RLum(list): Returns a list of data frames containing the structure of each RLum object in the input list.
structure_RLum(RLum.Analysis): Returns the structure of an RLum.Analysis object.

Function version

0.2.0

Author

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

How to cite

Kreutzer, S., 2025. structure_RLum(): General structure function for RLum-class objects. Function version 0.2.0. 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., Steinbuch, L., Boer, A.d., 2025. Luminescence: Comprehensive Luminescence Dating Data Analysis. R package version 1.1.2. https://r-lum.github.io/Luminescence/

Examples

Run this code


## load example data
data(ExampleData.XSYG, envir = environment())

## show structure
structure_RLum(OSL.SARMeasurement$Sequence.Object)

Run the code above in your browser using DataLab