dot-is_valid_computation_ready_delay_object: 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 whether a user input is a valid computation-ready delay object. This means it can be one of the following:

• a probability distribution vector: a numeric vector with no NA or negative values, whose entries sum up to 1

• a delay distribution matrix (as described in .check_is_delay_distribution_matrix)

Usage

.is_valid_computation_ready_delay_object(
  delay_object,
  parameter_name,
  incidence_data_length
)

Arguments

delay_object	user input object to be tested
parameter_name	A string containing the name the tested parameter had in the initial function in which it was passed.
incidence_data_length	A number representing the length of the given incidence data.

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.