get_RLum

0th

Percentile

General accessor function for RLum S4 class objects

Function calls object-specific get functions for RLum S4 class objects.

Keywords
utilities
Usage
get_RLum(object, ...)

# S4 method for list get_RLum(object, null.rm = FALSE, ...)

# S4 method for `NULL` get_RLum(object, ...)

Arguments
object

'>RLum (required): S4 object of class RLum or an object of type list containing only objects of type '>RLum

...

further arguments that will be passed to the object specific methods. For furter details on the supported arguments please see the class documentation: '>RLum.Data.Curve, '>RLum.Data.Spectrum, '>RLum.Data.Image, '>RLum.Analysis and '>RLum.Results

null.rm

logical (with default): option to get rid of empty and NULL objects

Details

The function provides a generalised access point for specific '>RLum objects. Depending on the input object, the corresponding get function will be selected. Allowed arguments can be found in the documentations of the corresponding '>RLum class.

Value

Return is the same as input objects as provided in the list.

Methods (by class)

  • list: Returns a list of '>RLum objects that had been passed to get_RLum

  • NULL: Returns NULL

Function version

0.3.2 (2018-01-21 17:22:38)

How to cite

Kreutzer, S. (2018). get_RLum(): General accessor function for RLum S4 class objects. Function version 0.3.2. In: Kreutzer, S., Burow, C., Dietze, M., Fuchs, M.C., Schmidt, C., Fischer, M., Friedrich, J. (2018). Luminescence: Comprehensive Luminescence Dating Data Analysis. R package version 0.8.6. https://CRAN.R-project.org/package=Luminescence

See Also

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

Aliases
  • get_RLum
  • get_RLum,list-method
  • get_RLum,NULL-method
Examples
# NOT RUN {
##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)

# }
Documentation reproduced from package Luminescence, version 0.8.6, License: GPL-3

Community examples

Looks like there are no examples yet.