int_datatype_matrix {dataquieR} | R Documentation |
Check declared data types of metadata in study data
Description
Checks data types of the study data and for the data type declared in the metadata
Usage
int_datatype_matrix(
resp_vars = NULL,
study_data,
label_col,
item_level = "item_level",
split_segments = FALSE,
max_vars_per_plot = 20,
threshold_value = 0,
meta_data = item_level,
meta_data_v2
)
Arguments
resp_vars |
variable the names of the measurement variables, if
missing or |
study_data |
data.frame the data frame that contains the measurements |
label_col |
variable attribute the name of the column in the metadata with labels of variables |
item_level |
data.frame the data frame that contains metadata attributes of study data |
split_segments |
logical return one matrix per study segment |
max_vars_per_plot |
integer from=0. The maximum number of variables per single plot. |
threshold_value |
numeric from=0 to=100. percentage failing conversions allowed to still classify a study variable convertible. |
meta_data |
data.frame old name for |
meta_data_v2 |
character path to workbook like metadata file, see
|
Details
This is a preparatory support function that compares study data with associated metadata. A prerequisite of this function is that the no. of columns in the study data complies with the no. of rows in the metadata.
For each study variable, the function searches for its data type declared in static metadata and returns a heatmap like matrix indicating data type mismatches in the study data.
List function.
Value
a list with:
-
SummaryTable
: data frame containing data quality check for "data type mismatch" (CLS_int_vfe_type
,PCT_int_vfe_type
). The following categories are possible: categories: "Non-matching datatype", "Non-Matching datatype, convertible", "Matching datatype" -
SummaryData
: data frame containing data quality check for "data type mismatch" for a report -
SummaryPlot
: ggplot2::ggplot2 heatmap plot, graphical representation ofSummaryTable
-
DataTypePlotList
: list of plots per (maybe artificial) segment -
ReportSummaryTable
: data frame underlyingSummaryPlot