create_inv_gamma_distr: Create an inverse-gamma distribution

create_inv_gamma_distrR Documentation

Create an inverse-gamma distribution

Description

Create an inverse-gamma distribution

Usage

create_inv_gamma_distr(
  id = NA,
  alpha = 0,
  beta = 1,
  value = NA,
  lower = NA,
  upper = NA
)

Arguments

id

the distribution's ID

alpha

the alpha shape parameter, a numeric value. For advanced usage, use the structure as returned by create_alpha_param

beta

the beta shape parameter, a numeric value. For advanced usage, use the structure as returned by create_beta_param

value

the initial value for the MCMC

lower

the lower bound, the lowest possible value

upper

an upper limit of the uniform distribution. If the upper limits needs to be infinity, set upper to Inf.

Value

an inverse-gamma distribution

Author(s)

Richèl J.C. Bilderbeek

See Also

the function create_distr shows an overview of all supported distributions

Examples

if (is_on_ci()) {

  inv_gamma_distr <- create_inv_gamma_distr()

  beast2_input_file <- get_beautier_tempfilename()
  create_beast2_input_file(
    input_filename = get_fasta_filename(),
    beast2_input_file,
    tree_prior = create_yule_tree_prior(
      birth_rate_distr = inv_gamma_distr
    )
  )
  file.remove(beast2_input_file)

  remove_beautier_folder()
}

ropensci/beautier documentation built on Nov. 3, 2023, 10:41 a.m.