util_generate_calls: Generate an execution/calling plan for computing a report...

In dataquieR: Data Quality in Epidemiological Research

Generate an execution/calling plan for computing a report from the metadata

Description

Generate an execution/calling plan for computing a report from the metadata

Usage

util_generate_calls(
  dimensions,
  meta_data,
  label_col,
  meta_data_segment,
  meta_data_dataframe,
  meta_data_cross_item,
  specific_args,
  arg_overrides,
  resp_vars,
  filter_indicator_functions
)

Arguments

dimensions	dimensions Vector of dimensions to address in the report. Allowed values in the vector are Completeness, Consistency, and Accuracy. The generated report will only cover the listed data quality dimensions. Accuracy is computational expensive, so this dimension is not enabled by default. Completeness should be included, if Consistency is included, and Consistency should be included, if Accuracy is included to avoid misleading detections of e.g. missing codes as outliers, please refer to the data quality concept for more details. Integrity is always included.
meta_data	data.frame the data frame that contains metadata attributes of study data
label_col	variable attribute the name of the column in the metadata with labels of variables
meta_data_segment	data.frame – optional: Segment level metadata
meta_data_dataframe	data.frame – optional: Data frame level metadata
meta_data_cross_item	data.frame – optional: Cross-item level metadata
specific_args	list named list of arguments specifically for one of the called functions, the of the list elements correspond to the indicator functions whose calls should be modified. The elements are lists of arguments.
arg_overrides	list arguments to be passed to all called indicator functions if applicable.
resp_vars	variables to be respected, NULL means to use all.
filter_indicator_functions	character regular expressions, only if an indicator function's name matches one of these, it'll be used for the report. If of length zero, no filtering is performed.

Value

a list of calls

dataquieR documentation built on July 26, 2023, 6:10 p.m.