check_rng_seed: Check if the input is a valid RNG seed.

Description Usage Arguments Value Author(s) Examples

View source: R/check_rng_seed.R

Description

Will stop if not.

Usage

1
check_rng_seed(rng_seed)

Arguments

rng_seed

the random number generator seed of the BEAST2 run. Must be a non-zero positive integer value or NA. If rng_seed is NA, BEAST2 will pick a random seed

Value

Nothing. Will stop if the RNG seed is invalid

Author(s)

Richèl J.C. Bilderbeek

Examples

1
2
3
4
5
# Numbers from 1 and higher are valid RNG seeds
check_rng_seed(1)
check_rng_seed(2)
# Also NA is a valid RNG seed
check_rng_seed(NA)

beastier documentation built on Sept. 19, 2021, 5:06 p.m.