dot-check_linelist: Check if R object is line list from 'sim_linelist()'

.check_linelistR Documentation

Check if R object is line list from sim_linelist()

Description

Check if R object is line list from sim_linelist()

Usage

.check_linelist(linelist)

Arguments

linelist

Line list ⁠<data.frame>⁠ output from sim_linelist().

Details

This is a check that the object supplied to linelist is from the sim_linelist() or sim_outbreak() functions, it is not related to the class of the object, in other words, it does not check the object is of class ⁠<linelist>⁠.

Value

Invisibly return the linelist ⁠<data.frame>⁠. The function is called for its side-effects, which will error if the input is invalid.


simulist documentation built on April 12, 2025, 1:34 a.m.