dot-is_valid_module_input: 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 that checks if a user input is one of:

• a numeric vector with values > 0

• a list with two elements: values (a numeric vector with values > 0) and index_offset (an integer)

Usage

.is_valid_module_input(module_input_object, parameter_name)

Arguments

module_input_object	the vector/list the user passed as a parameter, to be tested
parameter_name	A string containing the name the tested parameter had in the initial function in which it was passed.

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.