dot-check_linelist: Check if R object is line list from 'sim_linelist()'
In simulist: Simulate Disease Outbreak Line List and Contacts Data
.check_linelist R 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 Aug. 29, 2025, 5:34 p.m.
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
| .check_linelist | R 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 |
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.
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
Embedding an R snippet on your website
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.