Skip to contents

An assortment of functions to return model information.

Usage

supported_models()

supported_timed_models()

supported_optimizers()

supported_families()

supported_plots(model = NULL)

get_model(model)

model_parameters(model = NULL)

model_outputs(model = NULL)

Arguments

model

A string specifying a model. One from supported_models().

Value

supported_models() returns a character vector.

supported_timed_models() returns a character vector.

supported_optimizers() returns a character vector.

supported_families() returns a character vector.

supported_plots() returns a character vector or list (if model is NULL).

get_model() returns a model function.

model_parameters() returns a list or a list of lists (if model is NULL).

model_outputs() returns a character vector or list (if model is NULL).

Examples

# Outputs and plots supported by the RW1972 model
model_outputs("RW1972")
#> [1] "associations" "responses"   

# Getting the model function implementing the PKH1982 model
pkh_func <- get_model("PKH1982")
head(pkh_func, 10)
#>                                                                     
#> 1  function (ev = NULL, iv = NULL, parameters, experience, mapping, 
#> 2      ...)                                                         
#> 3  {                                                                
#> 4      .assert_no_functional(mapping)                               
#> 5      ntrials <- length(experience$tp)                             
#> 6      fsnames <- mapping$unique_functional_stimuli                 
#> 7      if (is.null(ev)) {                                           
#> 8          ev <- gen_ss_weights(fsnames)                            
#> 9      }                                                            
#> 10     if (is.null(iv)) {                                           

# Getting the parameters required by SM2007
model_parameters("SM2007")
#> $name
#> [1] "alphas"  "lambdas" "omegas"  "rhos"    "gammas"  "taus"    "order"  
#> 
#> $default_value
#> [1] 0.4 1.0 0.2 1.0 1.0 0.2 1.0
#>