simdesign_sobol {nlrx}

Add a sobol simdesign to a nl object

Description

Add a sobol simdesign to a nl object

Usage

simdesign_sobol(
  nl,
  samples,
  sobolorder,
  sobolnboot,
  sobolconf,
  nseeds,
  precision
)

Arguments

nl

nl object with a defined experiment

samples

number of samples for the sobol sensitivity analysis

sobolorder

order of interactions of the sobol sensitivity analysis

sobolnboot

number of bootstrap replicates of the sobol sensitivity analysis

sobolconf

the confidence level for bootstrap confidence intervals

nseeds

number of seeds for this simulation design

precision

number of digits for the decimal fraction of parameter values

Details

This function creates a simdesign S4 class which can be added to a nl object.

Variables in the experiment variable list need to provide a numeric distribution with min, max and qfun (e.g. list(min=1, max=4, qfun="qunif")).

The sobol simdesign uses the sensitivity package to set up a sobol sensitivity analysis, including a simobject of class sobol and a input tibble for simulations. For details on method specific sensitivity analysis function parameters see ?sobol Finally, the function reports a simdesign object.

Value

simdesign S4 class object

Examples

# To attach a simdesign, a nl object needs to be created first (see ?nl).
# For this example, we load a nl object from test data.

nl <- nl_sobol
nl@simdesign <- simdesign_sobol(nl=nl,
samples=1000,
sobolorder=2,
sobolnboot=100,
sobolconf=0.95,
nseeds=3,
precision=3)