dot-check_is_bootstrap_estimate: Utility functions for input validity.

In covid-19-Re/estimateR: Reproductive number estimation from delayed observations of infections

Utility functions for input validity.

Description

Utility function to check whether an object a valid bootstrap estimates object. It has to be a valid estimates object, and to have the columns specified by col_names.

Usage

.check_is_bootstrap_estimate(user_input, parameter_name, col_names)

Arguments

user_input	The variable to be tested
parameter_name	A string containing the name the tested parameter had in the initial function in which it was passed.
col_names	vector. Contains the column names of index_col, bootstrap_id_col and Re_estimate_col, as described by the summarise_uncertainty function.

Value

TRUE if all tests were passed. Throws an error otherwise.

covid-19-Re/estimateR documentation built on Sept. 14, 2024, 5:49 a.m.