util_compare_meta_with_study: Compares study data data types with the ones expected...

In dataquieR: Data Quality in Epidemiological Research

Compares study data data types with the ones expected according to the metadata

Description

Utility function to compare data type of study data with those defined in metadata

Usage

util_compare_meta_with_study(
  sdf,
  mdf,
  label_col,
  check_convertible = FALSE,
  threshold_value = 0,
  return_percentages = FALSE,
  check_conversion_stable = FALSE
)

Arguments

sdf	the data.frame of study data
mdf	the data.frame of associated static metadata
label_col	variable attribute the name of the column in the metadata with labels of variables
check_convertible	logical also try, if a conversion to the declared data type would work.
threshold_value	numeric from=0 to=100. percentage failing conversions allowed if check_convertible is TRUE.
return_percentages	logical return the percentage of mismatches.
check_conversion_stable	logical do not distinguish convertible from convertible, but with issues

Value

for return_percentages == FALSE: if check_convertible is FALSE, a binary vector ⁠(0, 1)⁠ if data type applies, if check_convertible is ⁠TRUE`` a vector with the states ⁠0, 1, 2, 3⁠: 0 = Mismatch, not convertible 1 = Match 2 = Mismatch, but convertible 3 = Mismatch, convertible, but with issues (e.g., loss of decimal places) for ⁠return_percentages == TRUE': a data frame with percentages of non-matching datatypes according, each column is a variable, the rows follow the vectors returned by util_check_data_type.

See Also

prep_dq_data_type_of

prep_datatype_from_data

Other data_management: util_assign_levlabs(), util_check_data_type(), util_check_group_levels(), util_dichotomize(), util_merge_data_frame_list(), util_rbind(), util_remove_na_records(), util_replace_hard_limit_violations(), util_study_var2factor(), util_table_of_vct()

dataquieR documentation built on May 29, 2024, 7:18 a.m.