validate_data_structure

This function checks if an input is of the specified data structure type(s).
Depending on the specified type, it will either throw an error, issue a
warning, or send a message. It also checks for NULL and NA values based on
the specified parameters.

Hospitals, hospital systems, and even trauma systems that
provide care to injured patients may not be aware of robust metrics
that can help gauge the efficacy of their programs in saving the lives
of injured patients. 'traumar' provides robust functions driven by
the academic literature to automate the calculation of relevant
metrics to individuals desiring to measure the performance of their
trauma center or even a trauma system. 'traumar' also provides some
helper functions for the data analysis journey. Users can refer to the
following publications for descriptions of the methods used in
'traumar'. TRISS methodology, including probability of survival, and
the W, M, and Z Scores - Flora (1978)
<doi:10.1097/00005373-197810000-00003>, Boyd et al. (1987,
PMID:3106646), Llullaku et al. (2009) <doi:10.1186/1749-7922-4-2>,
Singh et al. (2011) <doi:10.4103/0974-2700.86626>, Baker et al. (1974,
PMID:4814394), and Champion et al. (1989)
<doi:10.1097/00005373-198905000-00017>. For the Relative Mortality
Metric, see Napoli et al. (2017) <doi:10.1080/24725579.2017.1325948>,
Schroeder et al. (2019) <doi:10.1080/10903127.2018.1489021>, and
Kassar et al. (2016) <doi:10.1177/00031348221093563>. For more
information about methods to calculate over- and under-triage in
trauma hospital populations and samples, please see the following
publications - Peng & Xiang (2016) <doi:10.1016/j.ajem.2016.08.061>,
Beam et al. (2022) <doi:10.23937/2474-3674/1510136>, Roden-Foreman et
al. (2017) <doi:10.1097/JTN.0000000000000283>.

Nicolas Foss

traumar

Calculate Metrics for Trauma System Performance

Iowa Department of Health and Human Services 

validate_data_structure function

<dl><dt>input</dt>
<dd>The data to be validated.</dd>
<dt>structure_type</dt>
<dd>A vector of data structure types to check. Possible
values are "data.frame", "matrix", "list", "array", "atomic_vector",
"tbl_df", "tbl".</dd>
<dt>logic</dt>
<dd>The logical operator to use when combining checks. Possible
values are "or", and "and".</dd>
<dt>type</dt>
<dd>A character string specifying the type of message to be displayed
if the input is not numeric or if the values are out of range. Must be one
of "error", "warning", or "message".</dd>
<dt>na_ok</dt>
<dd>Logical. If TRUE, NA values are allowed. Default is TRUE.</dd>
<dt>null_ok</dt>
<dd>Logical. If TRUE, NULL values are allowed. Default is TRUE.</dd>
<dt>var_name</dt>
<dd>Optional. A character string giving the desired variable (or
object) name that will appear in console output in place of the how the
object will typically be named in messages via deparse(substitute(input)).</dd>
<dt>calls</dt>
<dd>Optional. The number of callers to go back in the call stack for
error messaging. If NULL, will default to 2.</dd></dl>

Arguments

Author

Validate Data Structure — validate_data_structure

<dl>

<dt>input</dt>
<dd>The data to be validated.</dd>


<dt>structure_type</dt>
<dd>A vector of data structure types to check. Possible
values are "data.frame", "matrix", "list", "array", "atomic_vector",
"tbl_df", "tbl".</dd>


<dt>logic</dt>
<dd>The logical operator to use when combining checks. Possible
values are "or", and "and".</dd>


<dt>type</dt>
<dd>A character string specifying the type of message to be displayed
if the input is not numeric or if the values are out of range. Must be one
of "error", "warning", or "message".</dd>


<dt>na_ok</dt>
<dd>Logical. If TRUE, NA values are allowed. Default is TRUE.</dd>


<dt>null_ok</dt>
<dd>Logical. If TRUE, NULL values are allowed. Default is TRUE.</dd>


<dt>var_name</dt>
<dd>Optional. A character string giving the desired variable (or
object) name that will appear in console output in place of the how the
object will typically be named in messages via deparse(substitute(input)).</dd>


<dt>calls</dt>
<dd>Optional. The number of callers to go back in the call stack for
error messaging. If NULL, will default to 2.</dd>

</dl>

validate_data_structure: Validate Data Structure

Description

Usage

Value

Arguments

Author