R/get_gamma_site_model_n_params.R

In beautier: 'BEAUti' from R

#' Get the number of distributions a site model has
#' @inheritParams default_params_doc
#' @return the number of parameters a site model has
#' @author Richèl J.C. Bilderbeek
#' @examples
#' check_empty_beautier_folder()
#'
#' # 0 parameters
#' get_gamma_site_model_n_params(
#'   create_gamma_site_model(gamma_cat_count = 0)
#' )
#'
#' # 0 parameters
#' get_gamma_site_model_n_params(
#'   create_gamma_site_model(gamma_cat_count = 1)
#' )
#'
#' # 1 parameter
#' get_gamma_site_model_n_params(
#'     create_gamma_site_model(
#'     gamma_cat_count = 2,
#'     gamma_shape_prior_distr = create_exp_distr()
#'   )
#' )
#'
#' check_empty_beautier_folder()
#' @export
get_gamma_site_model_n_params <- function(
  gamma_site_model
) {
  check_true(is_gamma_site_model(gamma_site_model))
  if (gamma_site_model$gamma_cat_count < 2) {
    0
  } else {
    get_distr_n_params(gamma_site_model$gamma_shape_prior_distr)
  }
}