Last data update: 2014.03.03

R: General accessor function for RLum S4 class objects
get_RLumR Documentation

General accessor function for RLum S4 class objects

Description

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

Usage

get_RLum(object, ...)

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

Arguments

object

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

null.rm

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

...

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

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

Function version

0.3.0 (2016-05-02 09:40:57)

Author(s)

Sebastian Kreutzer, IRAMAT-CRP2A, Universite Bordeaux Montaigne (France)
R Luminescence Package 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)


Results


R version 3.3.1 (2016-06-21) -- "Bug in Your Hair"
Copyright (C) 2016 The R Foundation for Statistical Computing
Platform: x86_64-pc-linux-gnu (64-bit)

R is free software and comes with ABSOLUTELY NO WARRANTY.
You are welcome to redistribute it under certain conditions.
Type 'license()' or 'licence()' for distribution details.

R is a collaborative project with many contributors.
Type 'contributors()' for more information and
'citation()' on how to cite R or R packages in publications.

Type 'demo()' for some demos, 'help()' for on-line help, or
'help.start()' for an HTML browser interface to help.
Type 'q()' to quit R.

> library(Luminescence)
Welcome to the R package Luminescence version 0.6.0 [Built: 2016-05-30 16:47:30 UTC]
The true age: 'How many roads...'
> png(filename="/home/ddbj/snapshot/RGM3/R_CC/result/Luminescence/get_RLum.Rd_%03d_medium.png", width=480, height=480)
> ### Name: get_RLum
> ### Title: General accessor function for RLum S4 class objects
> ### Aliases: get_RLum get_RLum,list-method
> ### Keywords: utilities
> 
> ### ** 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)

 [calc_CentralDose]

----------- meta data ----------------
 n:                       62
 log:                     TRUE
----------- dose estimate ------------
 central dose [Gy]:       65.71
 SE [Gy]:                 3.05
 rel. SE [%]:             4.65
----------- overdispersion -----------
 OD [Gy]:                 22.79
 SE [Gy]:                 2.27
 OD [%]:                  34.69
 SE [%]:                  3.46
-------------------------------------

> 
> ##get results and store them in a new object
> temp.get <- get_RLum(object = temp1)
> 
> 
> 
> 
> 
> 
> 
> dev.off()
null device 
          1 
>