get_RLum {Luminescence} | R Documentation |
General accessor function for RLum S4 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. Allowed arguments can be found in the documentations of the corresponding RLum class.
Usage
get_RLum(object, ...)
## S4 method for signature 'list'
get_RLum(object, class = NULL, null.rm = FALSE, ...)
## S4 method for signature 'NULL'
get_RLum(object, ...)
Arguments
object |
RLum (required):
S4 object of class |
... |
further arguments passed to the specific class method. |
class |
character (optional): allows to define the class that gets selected if applied to a list, e.g., if a list consists of different type of RLum objects, this arguments allows to make selection. If nothing is provided, all RLum-objects are treated. |
null.rm |
logical (with default): remove empty and |
Value
An object of the same type as the input object provided.
Functions
-
get_RLum(list)
: Returns a list of RLum objects that had been passed to get_RLum -
get_RLum(`NULL`)
: ReturnsNULL
.
Function version
0.3.3
How to cite
Kreutzer, S., 2025. get_RLum(): General accessor function for RLum S4 class objects. Function version 0.3.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., Steinbuch, L., Boer, A.d., 2025. Luminescence: Comprehensive Luminescence Dating Data Analysis. R package version 1.1.0. 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
## Example based using data and from the calc_CentralDose() function
## load example data
data(ExampleData.DeValues, envir = environment())
## apply the central dose model 1st time
temp1 <- calc_CentralDose(ExampleData.DeValues$CA1)
## get results and store them in a new object
temp.get <- get_RLum(object = temp1)