dot-check_is_estimate: Utility functions for input validity.
In covid-19-Re/estimateR: Reproductive number estimation from delayed observations of infections
.check_is_estimate R Documentation
Utility functions for input validity.
Description
Utility function to check whether an object is a valid estimates object.
It must be a dataframe and have an index column named index_col_name that doesn't contain any NA values.
Usage
.check_is_estimate(user_input, parameter_name, index_col_name)
Arguments
user_input
The variable to be tested
parameter_name
A string containing the name the tested parameter had in the initial function in which it was passed.
index_col_name
string. Name of the index column in the user_input dataframe.
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.
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_is_estimate | R Documentation |
Utility functions for input validity.
Description
Utility function to check whether an object is a valid estimates object.
It must be a dataframe and have an index column named index_col_name that doesn't contain any NA values.
Usage
.check_is_estimate(user_input, parameter_name, index_col_name)
Arguments
user_input |
The variable to be tested |
parameter_name |
A string containing the name the tested parameter had in the initial function in which it was passed. |
index_col_name |
string. Name of the index column in the |
Value
TRUE if all tests were passed. Throws an error otherwise.
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.