get_RuleBook {sandbox}R Documentation

Get One of a Series of Predefined Rule Books for a Model Run.

Description

The function returns a pre-built model rule book, i.e., a combination of model parameters and rules.

Usage

get_RuleBook(book = "empty", osl = NULL)

Arguments

book

character value, name of the rule book to be generated. One out of "empty", default is "empty".

osl

character value, optional keyword for an OSL (optical stimulated luminescence) model of choice. Must be one of the available models from the R package RLumModel-package. See details for full list of available models.

Details

It is possible to generate OSL-tailored rule books. For this, the argument osl must be provided with a keyword defining one of the OSL models from the R package 'RLumModel': "Bailey2001", "Bailey2004", "Pagonis2008", "Pagonis2007", "Bailey2002" and "Friedrich2017". The model parameters will be appended to the rule book entries and defined by mean and standard deviation.

Value

A list object with all rules for a model run.

Author(s)

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

Examples


## create simple true age-depth-relationship
book_flat <- get_RuleBook(book = "empty")


[Package sandbox version 0.2.1 Index]