List supported covariance models

Returns metadata for covariance models supported by the current sampler. This is a lightweight discovery helper for valid cov_model values and the theta parameters expected by each model.

Usage

get_cor_models()

Value

A named list describing available covariance models. Each entry contains the model's parameter names, parameter type codes, theta domains, and distance mode code.

Details

The domains entry is used to validate theta priors. Positive theta parameters require finite positive support. Unit theta parameters have support within \([0,1]\).

The returned metadata applies to covariance-model labels used by gp() and nngp() terms. CAR-family terms have fixed parameter names documented in stLMM_terms.

Examples

names(get_cor_models())
#> [1] "exp"               "matern"            "sep_exp"          
#> [4] "multi_res_sep_exp" "gneiting"         
get_cor_models()[["exp"]]
#> $names
#> [1] "phi"
#> 
#> $types
#> [1] 1
#> 
#> $domains
#> [1] "positive"
#> 
#> $distance_mode
#> [1] 1
#> 
get_cor_models()[["matern"]]
#> $names
#> [1] "phi" "nu" 
#> 
#> $types
#> [1] 1 1
#> 
#> $domains
#> [1] "positive" "positive"
#> 
#> $distance_mode
#> [1] 1
#>