sandbox (version 0.2.2)

set_Rule: Set depth-dependent rule for model parameter.

Description

The function defines how the specified model parameter varies with depth. The transfer function uses different interpolation functions to create a continuous representation of a parameter value with depth.

Usage

set_Rule(book, parameter, value, depth, type = "spline")

Value

A list object with all created formula objects.

Arguments

book

list object, rule book to be edited.

parameter

character scalar, parameter name to be edited. Can also be the keyword for an OSL model. See details.

value

numeric list, specifying the parameter values at the corresponding depth points. If a parameter is defined by more than one argument (e.g., mean and standard deviation), all the relevant arguments must be defined for each corresponding depth as separate list element.

depth

numeric list, specifying the depths used for the interpolation. All elements must be of the same lengths as the corresponding data in value.

type

character scalar, interpolation method. One out of spline, default is spline.

Author

Michael Dietze, GFZ Potsdam (Germany), Sebastian Kreutzer, Geography & Earth Sciences, Aberystwyth University (United Kingdom)

Details

To assign standard OSL model parameters, one of the available keywords of the R package RLumModel can be used. The function will then set all rules of the rule book with the standard values associated with these models, and setting the standard deviation to zero. The keyword can be one out of "Bailey2001", "Bailey2004", "Pagonis2008", "Pagonis2007", "Bailey2002" and "Friedrich2017". This will fill the rule book with the standard parameters independent of depth. Note that a dose rate (parameter name osl_doserate) needs to be set separately!

Examples

## create empty rule book
book_01 <- get_RuleBook()

## assign rule definitions to lists
depth <- list(c(0, 10))
age <- list(c(0, 1000))

## add age definition
book_01 <- set_Rule(
 book = book_01, 
 parameter = "age", 
 value = age, 
 depth = depth)