create_normal_distr: Create an normal distribution

create_normal_distrR Documentation

Create an normal distribution

Description

Create an normal distribution

Usage

create_normal_distr(
  id = NA,
  mean = 0,
  sigma = 1,
  value = NA,
  lower = NA,
  upper = NA
)

Arguments

id

the distribution's ID

mean

the mean parameter, a numeric value. For advanced usage, use the structure as returned by create_mean_param

sigma

the sigma parameter, a numeric value. For advanced usage, use the structure as returned by create_sigma_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

a normal 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()) {

  normal_distr <- create_normal_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 = normal_distr
    )
  )
  file.remove(beast2_input_file)

  remove_beautier_folder()
}

richelbilderbeek/beastscriptr documentation built on Nov. 5, 2023, 8:36 p.m.