models: models

In AIMS/bayesnec: A Bayesian No-Effect- Concentration (NEC) Algorithm

models

Description

Lists the fitted or available models.

Usage

models(object)

Arguments

object

An object of class bayesnecfit or bayesmanecfit as returned by bnec, a character vector indicating the type of model set for which to list the available models, or a numeric vector indicating the natural range of values which the models should be able to handle (see Details). If missing, all available models and their groups are listed.

Details

The available models are "nec3param", "nec4param", "nechorme", "nechorme4", "necsigm", "neclin", "neclinhorme", "nechormepwr", "nechorme4pwr", "nechormepwr01", "ecxlin", "ecxexp", "ecxsigm", "ecx4param", "ecxwb1", "ecxwb2", "ecxwb1p3", "ecxwb2p3", "ecxll5", "ecxll4", "ecxll3", "ecxhormebc4", and "ecxhormebc5".

To see the model formula and parameters for a specific model use the function show_params.

To see all the models in an available set (e.g. "all", "nec" or ecx") use the function models specifying the group name.

To see the model names, model formula and parameters fitted in an existing bayesnecfit or bayesmanecfit model object use the function models specifying the fitted object.

To see what models are available for a given type of data use the function models passing a numeric vector indicating the range of possible data types. Models that have an exponential decay (most models with parameter "beta") with no "bot" parameter are zero-bounded and are not suitable for the Gaussian family, or any family modelled using a logit or log link function. Models with a linear decay (containing the string "lin" in their name) are not suitable for modelling families that are zero bounded (Gamma, Poisson, Negative binomial) using an identity link. Models with a linear decay or hormesis linear increase (all models with parameter "slope") are not suitable for modelling families that are 0, 1 bounded (binomial, beta, beta_binomial). These restrictions do not need to be controlled by the user and a call to bnec with models = "all" will simply exclude inappropriate models.

Value

A list of the available or fitted models.

Examples

library(bayesnec)
# default to all models and model groups
models()
# single model
show_params("nec3param")
# group of models
models("all")
# models that are suitable for 0,1 bounded data
models(c(0,1))

AIMS/bayesnec documentation built on April 1, 2024, 8:51 p.m.