dot-check_is_delay_distribution_matrix: 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 given matrix is a valid delay distribution matrix. For this, the matrix needs to fulfill the following conditions:

• is a numeric matrix

• has no values < 0

• is a lower triangular matrix

• no column sums up to more than 1

• no NA values

• the size of the matrix is greater than the length of the incidence data

Usage

.check_is_delay_distribution_matrix(
  delay_matrix,
  incidence_data_length,
  parameter_name
)

Arguments

delay_matrix	A matrix to be tested
incidence_data_length	A number representing the length of the given incidence data.
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.