R: General merge function for RLum S4 class objects
merge_RLum
R Documentation
General merge function for RLum S4 class objects
Description
Function calls object-specific merge functions for RLum S4 class objects.
Usage
merge_RLum(objects, ...)
Arguments
objects
list of RLum
(required): list of S4 object of class RLum
...
further arguments that one might want to pass to the specific
merge function
Details
The function provides a generalised access point for merge specific
RLum objects. Depending on the input object, the
corresponding merge function will be selected. Allowed arguments can be
found in the documentations of each merge function. Empty list elements (NULL) are
automatically removed from the input list.
object
corresponding merge function
RLum.Data.Curve
:
merge_RLum.Data.Curve
RLum.Analysis
:
merge_RLum.Analysis
RLum.Results
:
merge_RLum.Results
Value
Return is the same as input objects as provided in the list.
Function version
0.1.2 (2016-05-02 09:36:06)
Note
So far not for every RLum object a merging function exists.
Author(s)
Sebastian Kreutzer, IRAMAT-CRP2A, Universite Bordeaux Montaigne
(France)
R Luminescence Package Team
##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)
##apply the central dose model 2nd time
temp2 <- calc_CentralDose(ExampleData.DeValues$CA1)
##merge the results and store them in a new object
temp.merged <- get_RLum(merge_RLum(objects = list(temp1, temp2)))
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]
An unbiased reviewer: 'The data is too poor to be published in QG, try a higher ranked journal.'
> png(filename="/home/ddbj/snapshot/RGM3/R_CC/result/Luminescence/merge_RLum.Rd_%03d_medium.png", width=480, height=480)
> ### Name: merge_RLum
> ### Title: General merge function for RLum S4 class objects
> ### Aliases: merge_RLum
> ### 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
-------------------------------------
>
> ##apply the central dose model 2nd time
> temp2 <- 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
-------------------------------------
>
> ##merge the results and store them in a new object
> temp.merged <- get_RLum(merge_RLum(objects = list(temp1, temp2)))
>
>
>
>
>
>
>
> dev.off()
null device
1
>