set_RLum: General setter function for RLum S4 class objects

In Luminescence: Comprehensive Luminescence Dating Data Analysis

General setter function for RLum S4 class objects

Description

The function provides a generalised access point for specific RLum objects. Depending on the given class, the corresponding method to create an object from this class will be selected. Allowed additional arguments can be found in the documentations of the corresponding RLum class:

• RLum.Data.Curve,

• RLum.Data.Image,

• RLum.Data.Spectrum,

• RLum.Analysis,

• RLum.Results

Usage

set_RLum(class, originator, .uid = create_UID(), .pid = NA_character_, ...)

Arguments

class	character (required): name of the S4 class to create, must correspond to one of the RLum classes.
originator	character (automatic): contains the name of the calling function (the function that produces this object); can be set manually.
.uid	character (automatic): unique ID for this object, by default set using the internal C++ function create_UID.
.pid	character (with default): option to provide a parent id for nesting at will.
...	further arguments passed to the specific class method

Value

An object of the specified RLum class.

Function version

0.3.0

How to cite

Kreutzer, S., 2025. set_RLum(): General setter function for RLum S4 class objects. Function version 0.3.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.0.1. https://r-lum.github.io/Luminescence/

Author(s)

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

See Also

RLum.Data.Curve, RLum.Data.Image, RLum.Data.Spectrum, RLum.Analysis, RLum.Results

Examples

## produce empty objects from each class
set_RLum(class = "RLum.Data.Curve")
set_RLum(class = "RLum.Data.Spectrum")
set_RLum(class = "RLum.Data.Spectrum")
set_RLum(class = "RLum.Analysis")
set_RLum(class = "RLum.Results")

## produce a curve object with arbitrary curve values
object <- set_RLum(
class = "RLum.Data.Curve",
curveType = "arbitrary",
recordType = "OSL",
data = matrix(c(1:100,exp(-c(1:100))),ncol = 2))

## plot this curve object
plot_RLum(object)

Luminescence documentation built on April 3, 2025, 7:52 p.m.