Methods for S3-generics implemented for the package 'RLumCarlo'.

# S3 method for RLumCarlo_Model_Output
summary(object, verbose = TRUE, ...)

# S3 method for RLumCarlo_Model_Output
c(...)

Arguments

object

list of class RLumCarlo_Model_Output: RLumCarlo simulation output object produced by all run_ functions

verbose

logical (with default): enable/disable verbose mode

...

input objects or further function arguments

Value

summary(): This function returns a data.frame

c(): function returns a the same as the input objects

Author

Sebastian Kreutzer, Institute of Geography, Heidelberg University (Germany), Johannes Friedrich, University of Bayreuth (Germany),

How to cite

Kreutzer, S., Friedrich, J., 2022. methods_RLumCarlo(): methods_RLumCarlo. In: Friedrich, J., Kreutzer, S., Pagonis, V., Schmidt, C., 2022. RLumCarlo: Monte-Carlo Methods for Simulating Luminescence Phenomena. R package version 0.1.9. https://CRAN.R-project.org/package=RLumCarlo

Examples


##create object
object <- run_MC_TL_DELOC(
 s = 3.5e12,
 E = 1.45,
 R = 0.1,
 method = 'seq',
 clusters = 100,
 times = 150:350)

##summary
summary(object)
#>       time          mean             y_min            y_max       
#>  Min.   :150   Min.   :0.00000   Min.   :0.0000   Min.   :0.0000  
#>  1st Qu.:200   1st Qu.:0.03194   1st Qu.:0.0000   1st Qu.:0.1348  
#>  Median :250   Median :0.21061   Median :0.1042   Median :0.4257  
#>  Mean   :250   Mean   :0.97476   Mean   :0.7522   Mean   :1.3247  
#>  3rd Qu.:300   3rd Qu.:1.56919   3rd Qu.:1.1342   3rd Qu.:2.1211  
#>  Max.   :350   Max.   :4.23978   Max.   :3.6048   Max.   :5.1078  
#>        sd                var                 sum         
#>  Min.   :0.000000   Min.   :0.000e+00   Min.   :  0.000  
#>  1st Qu.:0.001638   1st Qu.:2.680e-06   1st Qu.:  3.194  
#>  Median :0.046662   Median :2.177e-03   Median : 21.061  
#>  Mean   :0.114916   Mean   :3.469e-02   Mean   : 97.476  
#>  3rd Qu.:0.190812   3rd Qu.:3.641e-02   3rd Qu.:156.919  
#>  Max.   :0.500430   Max.   :2.504e-01   Max.   :423.978  

##combine
c(objects,objects)
#> [[1]]
#> function (name, pos = -1L, envir = as.environment(pos), all.names = FALSE, 
#>     pattern, sorted = TRUE) 
#> {
#>     if (!missing(name)) {
#>         pos <- tryCatch(name, error = function(e) e)
#>         if (inherits(pos, "error")) {
#>             name <- substitute(name)
#>             if (!is.character(name)) 
#>                 name <- deparse(name)
#>             warning(gettextf("%s converted to character string", 
#>                 sQuote(name)), domain = NA)
#>             pos <- name
#>         }
#>     }
#>     all.names <- .Internal(ls(envir, all.names, sorted))
#>     if (!missing(pattern)) {
#>         if ((ll <- length(grep("[", pattern, fixed = TRUE))) && 
#>             ll != length(grep("]", pattern, fixed = TRUE))) {
#>             if (pattern == "[") {
#>                 pattern <- "\\["
#>                 warning("replaced regular expression pattern '[' by  '\\\\['")
#>             }
#>             else if (length(grep("[^\\\\]\\[<-", pattern))) {
#>                 pattern <- sub("\\[<-", "\\\\\\[<-", pattern)
#>                 warning("replaced '[<-' by '\\\\[<-' in regular expression pattern")
#>             }
#>         }
#>         grep(pattern, all.names, value = TRUE)
#>     }
#>     else all.names
#> }
#> <bytecode: 0x7fdb9b8e9fa0>
#> <environment: namespace:base>
#> 
#> [[2]]
#> function (name, pos = -1L, envir = as.environment(pos), all.names = FALSE, 
#>     pattern, sorted = TRUE) 
#> {
#>     if (!missing(name)) {
#>         pos <- tryCatch(name, error = function(e) e)
#>         if (inherits(pos, "error")) {
#>             name <- substitute(name)
#>             if (!is.character(name)) 
#>                 name <- deparse(name)
#>             warning(gettextf("%s converted to character string", 
#>                 sQuote(name)), domain = NA)
#>             pos <- name
#>         }
#>     }
#>     all.names <- .Internal(ls(envir, all.names, sorted))
#>     if (!missing(pattern)) {
#>         if ((ll <- length(grep("[", pattern, fixed = TRUE))) && 
#>             ll != length(grep("]", pattern, fixed = TRUE))) {
#>             if (pattern == "[") {
#>                 pattern <- "\\["
#>                 warning("replaced regular expression pattern '[' by  '\\\\['")
#>             }
#>             else if (length(grep("[^\\\\]\\[<-", pattern))) {
#>                 pattern <- sub("\\[<-", "\\\\\\[<-", pattern)
#>                 warning("replaced '[<-' by '\\\\[<-' in regular expression pattern")
#>             }
#>         }
#>         grep(pattern, all.names, value = TRUE)
#>     }
#>     else all.names
#> }
#> <bytecode: 0x7fdb9b8e9fa0>
#> <environment: namespace:base>
#>