set_Parameter {sandbox} | R Documentation |
Set Profile- and Grain-Specific Model Parameters.
Description
The function defines one model parameter used to generate a set of virtual grains. A parameter is defined in a probabilistic way, as parametric distribution function. Each parameter of the distribution function can be changed through time using set_Rule.
Usage
set_Parameter(book, parameter, type)
Arguments
book |
list object, rule book to be edited. |
parameter |
character scalar, keyword defining the parameter to be defined. Some parameters can be described by more than one function, see details. |
type |
character scalar, keyword defining the distribution
function used to describe the parameter. See details for available
keywords, default is |
Details
The following parameter types are available:
-
exact
: parameter does not vary at all. No additional parameters needed except for vectorvalue
, defining the constant values for corresponding depths. -
uniform
: parameter varies following a uniform distribution. The following additional parameter vectors are required:min
(minimum) andmax
(maximum) -
normal
: parameter varies following a normal distribution, which is defined by mean and standard deviation -
gamma
: parameter varies following a gamma distribution, defined by shape parameter, scale parameter) and offset (defining constant offset of values)
Value
A list object.
Author(s)
Michael Dietze, GFZ Potsdam (Germany)
Examples
## get empty rule book
book_1 <- get_RuleBook(book = "empty")
## set density from default "normal" to "exact"
book_2 <- set_Parameter(book = book_1,
parameter = "density",
type = "exact")
book_1$density$density_1$type
book_2$density$density_1$type