get_sanity_checks {sanityTracker}

Returns all performed sanity checks

Description

Returns all performed sanity checks

Usage

get_sanity_checks()

Value

all sanity checks, i.e. a data.table with the following column

description

character that was provided by the user through the parameter description

additional_desc

character that provides additional information about the check that was generated by the convenience functions

data_name

name of the data set that passed to the function that performed the sanity check. This can also be specified by the user

n

a logical vector is the basis of all sanity checks. This is length of the logical vector that was used, which in general is the number of rows of the table that was checked

n_fail

how often the logical vector was TRUE

n_na

how often the logical vector was NA

counter_meas

character provided by the user about how a fail will be addressed. Note that this never happens inside a function of sanityTracker but is realized by the user after the check was performed. It is only for documentation when the results of the checks are displayed.

fail_vec_str

this captures how the actual logical vector of fails was build

param_name

usually generated by the convenience functions and it also may be a composition of more than one parameter name. However this parameter could also have been provided by the user

call

character of the call where the sanity check happend

example

if a check failed and the table is available, then some examples of rows that lead to the fail are stored here

See Also

add_sanity_check