Learn R Programming

sandbox (version 0.2.2)

get_RuleBook: 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)

Value

A list object with all rules for a model run.

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. See details for full list of available models.

Author

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

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.

Examples

Run this code

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

Run the code above in your browser using DataLab