check_n_threads: Check if the input is a valid number of threads.

Description Usage Arguments Value Author(s) Examples

View source: R/check_n_threads.R

Description

Will stop if not.

Usage

1
check_n_threads(n_threads)

Arguments

n_threads

the number of computational threads to use. Use NA to use the BEAST2 default of 1.

Value

Nothing. Will stop if the number of threads in invalid

Author(s)

Richèl J.C. Bilderbeek

Examples

1
2
3
4
5
# Can have 1 or more threads
check_n_threads(1)
check_n_threads(2)
# Can have NA threads
check_n_threads(NA)

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