create_scale_param: Create a parameter called scale

In ropensci/beautier: 'BEAUti' from R

Create a parameter called scale

Description

Create a parameter called scale

Usage

create_scale_param(id = NA, value = 0)

Arguments

id	the parameter's ID
value	value of the parameter

Value

a parameter called scale

Note

this parameter is used in a Laplace distribution (as returned by create_laplace_distr)

Author(s)

Richèl J.C. Bilderbeek

See Also

the function create_param contains a list of all parameters that can be created

Examples

if (is_on_ci()) {
  # Create the parameter
  scale_param <- create_scale_param()

  # Use the parameter in a distribution
  laplace_distr <- create_laplace_distr(
    scale = scale_param
  )

  # Use the distribution to create a BEAST2 input file
  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 = laplace_distr
    )
  )
  file.remove(beast2_input_file)

  remove_beautier_folder()
}

ropensci/beautier documentation built on April 2, 2024, 5:01 a.m.