Man pages for dataquieR
Data Quality in Epidemiological Research

acc_cat_distributionsPlots and checks for distributions for categorical variables
acc_distributionsPlots and checks for distributions
acc_distributions_ecdfECDF plots for distribution checks
acc_distributions_locPlots and checks for distributions - Location
acc_distributions_onlyPlots and checks for distributions - only
acc_distributions_propPlots and checks for distributions - Proportion
acc_end_digitsExtension of acc_shape_or_scale to examine uniform...
acc_loessSmoothes and plots adjusted longitudinal measurements and...
acc_mahalanobisCalculate and plot Mahalanobis distances for social science...
acc_marginsEstimate marginal means, see emmeans::emmeans
acc_multivariate_outlierCalculate and plot Mahalanobis distances
acc_robust_univariate_outlierIdentify univariate outliers by four different approaches
acc_shape_or_scaleCompare observed versus expected distributions
acc_univariate_outlierIdentify univariate outliers by four different approaches
acc_varcompUtility function to compute model-based ICC depending on the...
API_VERSIONVersion of the API
as.character.interval'as.character' implementation for the class 'interval'
as.data.frame.dataquieR_resultsetConvert a full 'dataquieR' report to a 'data.frame'
as.list.dataquieR_resultsetConvert a full 'dataquieR' report to a 'list'
as.list.dataquieR_resultset2inefficient way to convert a report to a list. try...
ASSOCIATION_DIRECTIONCross-item level metadata attribute name
ASSOCIATION_FORMCross-item level metadata attribute name
ASSOCIATION_METRICCross-item level metadata attribute name
ASSOCIATION_RANGECross-item level metadata attribute name
cash-.dataquieR_resultset2Access single results from a dataquieR_resultset2 report
cash-set-.dataquieR_resultset2Write single results from a dataquieR_resultset2 report
CHECK_IDCross-item level metadata attribute name
CHECK_LABELCross-item level metadata attribute name
check_tableData frame with contradiction rules
CODE_CLASSEStypes of value codes
CODE_LIST_TABLEDefault Name of the Table featuring Code Lists
CODE_ORDEROnly existence is checked, order not yet used
com_item_missingnessSummarize missingness columnwise (in variable)
COMPUTATION_RULECross-item level metadata attribute name
COMPUTED_VARIABLE_ROLES'SSI' related Cross-item level metadata attribute names...
com_qualified_item_missingnessCompute Indicators for Qualified Item Missingness
com_qualified_segment_missingnessCompute Indicators for Qualified Segment Missingness
com_segment_missingnessSummarizes missingness for individuals in specific segments
com_unit_missingnessCounts all individuals with no measurements at all
con_contradictionsChecks user-defined contradictions in study data
con_contradictions_redcapChecks user-defined contradictions in study data
con_inadmissible_categoricalDetects variable levels not specified in metadata
con_inadmissible_vocabularyDetects variable levels not specified in standardized...
con_limit_deviationsDetects variable values exceeding limits defined in metadata
contradiction_functionscontradiction_functions
contradiction_functions_descriptionsdescription of the contradiction functions
CONTRADICTION_TERMCross-item level metadata attribute name
CONTRADICTION_TYPECross-item level metadata attribute name
DATA_PREPARATIONCross-item level metadata attribute name
dataquieRThe 'dataquieR' package about Data Quality in Epidemiological...
dataquieR.acc_loess.exclude_constant_subgroupsExclude subgroups with constant values from LOESS figure
dataquieR.acc_loess.mark_time_pointsDisplay time-points in LOESS plots
dataquieR.acc_loess.min_bwLower limit for the LOESS bandwidth
dataquieR.acc_loess.min_proportionLower limit for the proportion of cases or controls to create...
dataquieR.acc_loess.plot_formatdefault for Plot-Format in 'acc_loess()'
dataquieR.acc_loess.plot_observationsDisplay observations in LOESS plots
dataquieR.acc_margins_numInclude number of observations for each level of the grouping...
dataquieR.acc_margins_sortSort levels of the grouping variable in the 'margins' figures
dataquieR.acc_multivariate_outlier.scaleApply min-max scaling in parallel coordinates figure to...
dataquieR.applicability_problemAn exception class assigned for exceptions caused by trying...
dataquieR.col_con_con_empiricalColor for empirical contradictions
dataquieR.col_con_con_logicalColor for logical contradictions
dataquieR.CONDITIONS_LEVEL_TRHESHOLDLog Level
dataquieR.CONDITIONS_WITH_STACKTRACEAdd stack-trace in condition messages (to be deprecated)
dataquieR.convert_to_list_for_lapplyIf report uses a 'storr' back-end, do not convert to...
dataquieR.debugCall 'browser()' on errors
dataquieR.des_summary_hard_lim_removeRemoval of hard limits from data before calculating...
dataquieR.dontwrapresultsDisable automatic post-processing of 'dataquieR' function...
dataquieR.droplevels_ReportSummaryTableShow also unused levels in heatmaps
dataquieR.dt_adjustcharacter Adjust data types according to metadata
dataquieR.ELEMENT_MISSMATCH_CHECKTYPEMetadata describes more than the current study data
dataquieR.ERRORS_WITH_CALLERSet caller for error conditions (to be deprecated)
dataquieR.fix_column_type_on_readTry to avoid fallback to string columns when reading files
dataquieR.flip_modeFlip-Mode to Use for figures
dataquieR.force_item_specific_missing_codesConverting MISSING_LIST/JUMP_LIST to a MISSING_LIST_TABLE...
dataquieR.force_label_colControl, how the 'label_col' argument is used.
dataquieR.GAM_for_LOESSEnable to switch to a general additive model instead of LOESS
dataquieR.grading_formatsName of the data.frame featuring a format for grading-values
dataquieR.grading_rulesetsName of the data.frame featuring GRADING_RULESET
dataquieR.guess_characterFor metadata guessing, try to guess DATA_TYPE from the data...
dataquieR.guess_missing_codesControl, if 'dataquieR' tries to guess missing-codes from the...
dataquieR.ignore_empty_varscharacter remove variables with only empty values
dataquieR.intrinsic_applicability_problemAn exception class assigned for exceptions caused by trying...
dataquieR.langLanguage-Suffix for metadata Label-Columns
dataquieR.lazy_plotscharacter plots realized lazy
dataquieR.lazy_plots_cachecharacter cache realizations
dataquieR.lazy_plots_gg_compatibilitycharacter be as compatible with 'ggplot2' objects as possible
dataquieR.localecharacter default language for type conversion
dataquieR.MAHALANOBIS_THRESHOLDDefault availability of Mahalanobis based multivariate...
dataquieR.max_cat_resp_var_levels_in_plotMaximum number of levels of the categorical response variable...
dataquieR.max_group_var_levels_in_plotMaximum number of levels of the grouping variable shown...
dataquieR.max_group_var_levels_with_violinsMaximum number of levels of the grouping variable shown with...
dataquieR.MAX_LABEL_LENMaximum length for variable labels LABEL
dataquieR.MAX_LONG_LABEL_LENMaximum length for long variable labels LONG_LABEL
dataquieR.MAX_VALUE_LABEL_LENMaximum length for value labels
dataquieR.MESSAGES_WITH_CALLERSet caller for message conditions (to be deprecated)
dataquieR.min_obs_per_group_var_in_plotMinimum number of observations per grouping variable that is...
dataquieR.min_time_points_for_cat_resp_varMinimum number of data points to create a time course plot...
dataquieR.MULTIVARIATE_OUTLIER_CHECKDefault availability of multivariate outlier checks in...
dataquieR.non_disclosureRemove all observation-level-real-data from reports
dataquieR.old_factor_handlingcharacter use the old handling of study data already...
dataquieR.old_type_adjustcharacter use the old type conversion code (slower)
dataquieR.precomputeStudyDataPre-compute different curation levels of study data
dataquieR.print_block_load_factornumeric
dataquieR.progress_fkt_defaultfunction to call on progress increase
dataquieR.progress_msg_fkt_defaultfunction to call on progress message update
dataquieR_resultsetInternal constructor for the internal class...
dataquieR_resultset2-classClass dataquieR_resultset2.
dataquieR_resultset_verifyVerify an object of class dataquieR_resultset
dataquieR.resume_checkpointIf result already exists in a 'storr' back-end, re-use it
dataquieR.resume_printIf output folder is not empty, try to resume stopped...
dataquieR.scale_level_heuristics_control_binaryrecodelimitNumber of levels to consider a variable ordinal in absence of...
dataquieR.scale_level_heuristics_control_metriclevelsNumber of levels to consider a variable metric in absence of...
dataquieR.study_data_cache_maxMaximum size of cache for curated study data
dataquieR.study_data_cache_metricsCollect metrics on cache usage of study data cache
dataquieR.study_data_cache_metrics_envenvironment for storing metrics on the study data cache
dataquieR.study_data_cache_metrics_env_defaultDefault space for some metrics during report computation
dataquieR.study_data_cache_quick_fillControl the pre-computation of curation levels of study data
dataquieR.study_data_colnames_case_sensitivecharacter Are column names in study data considered...
dataquieR.testdebugDisable all interactively used metadata-based function...
dataquieR.tracebackInclude full trace-back in captured conditions
dataquieR.type_adjust_parallelcharacter try to do type adjustments in parallel only, if...
dataquieR.VALUE_LABELS_htmlescapedAssume, all VALUE_LABELS are HTML escaped
dataquieR.WARNINGS_WITH_CALLERSet caller for warning conditions (to be deprecated)
DATA_TYPESData Types
DATA_TYPES_OF_R_TYPEAll available data types, mapped from their respective R...
DescriptorDescriptor Function
des_scatterplot_matrixCompute Pairwise Correlations
des_summaryCompute Descriptive Statistics
des_summary_categoricalCompute Descriptive Statistics - categorical variables
des_summary_continuousCompute Descriptive Statistics - continuous variables
DF_CODEData frame level metadata attribute name
DF_ELEMENT_COUNTData frame level metadata attribute name
DF_ID_REF_TABLEData frame level metadata attribute name
DF_ID_VARSData frame level metadata attribute name
DF_NAMEData frame level metadata attribute name
DF_RECORD_CHECKData frame level metadata attribute name
DF_RECORD_COUNTData frame level metadata attribute name
DF_UNIQUE_IDData frame level metadata attribute name
DF_UNIQUE_ROWSData frame level metadata attribute name
dim.dataquieR_resultset2Get the dimensions of a 'dq_report2' result
dimensionsNames of DQ dimensions
dimnames.dataquieR_resultset2Names of a 'dataquieR' report object (v2.0)
dimsDimension Titles for Prefixes
DISTRIBUTIONSAll available probability distributions for...
dot-get_internal_apiGet Access to Utility Functions
dot-numeric_with_unitOperator caring for units
dot-template_function_indicator'Roxygen'-Template for indicator functions
dot-variable_arg_rolesVariable-argument roles
dq_lazy_ggplot_methodsS3/S7 methods for lazy ggplot objects
dq_reportGenerate a full DQ report
dq_report2Generate a full DQ report, v2
dq_report_byGenerate a stratified full DQ report
droplevels.ReportSummaryTableRemove unused levels from 'ReportSummaryTable'
GOLDSTANDARDCross-item level metadata attribute name
grapes-grapes-.numeric_with_unitOperator caring for units
grapes-slash-grapes-.numeric_with_unitOperator caring for units
grid.draw.util_pairs_ggplot_panels'grid.draw' method for 'util_pairs_ggplot_panels' objects
html_dependency_clipboardHTML Dependency for report headers in 'clipboard'
html_dependency_dataquieRHTML Dependency for 'dataquieR'
html_dependency_jspdfHTML dependency for 'jsPDF'
html_dependency_report_dtHTML Dependency for report headers in 'DT::datatable'
html_dependency_tippyHTML Dependency for 'tippy'
html_dependency_vert_dtHTML Dependency for vertical headers in 'DT::datatable'
IndicatorIndicator Function
int_all_datastructure_dataframeWrapper function to check for studies data structure
int_all_datastructure_segmentWrapper function to check for segment data structure
int_datatype_matrixCheck declared data types of metadata in study data
int_duplicate_contentCheck for duplicated content
int_duplicate_idsCheck for duplicated IDs
int_encoding_errorsEncoding Errors
int_part_vars_structureDetect Expected Observations
int_sts_element_dataframeDetermine missing and/or superfluous data elements
int_sts_element_segmentChecks for element set
int_unexp_elementsCheck for unexpected data element count
int_unexp_records_dataframeCheck for unexpected data record count at the data frame...
int_unexp_records_segmentCheck for unexpected data record count within segments
int_unexp_records_setCheck for unexpected data record set
IRVCross-item level metadata attribute name
MAHALANOBIS_THRESHOLDCross-item level metadata attribute name
MAXIMUM_LONG_STRINGCross-item level metadata attribute name
menu_env_drop_downCreates a drop-down menu
menu_env-menuGenerate the menu for a report
menu_env_menu_entryCreate a single menu entry
meta_dataData frame with metadata about the study data on variable...
meta_data_computationWell known columns on the 'item_computation_level' sheet
meta_data_crossWell known columns on the 'cross-item_level' sheet
meta_data_dataframeWell known columns on the 'meta_data_dataframe' sheet
meta_data_env'.meta_data_env' - an environment for easy metadata access
meta_data_env_co_varsExtract co-variables for a given item
meta_data_segmentWell known columns on the 'meta_data_segment' sheet
MISS_RESPCross-item level metadata attribute name
MULTIVARIATE_OUTLIER_CHECKCross-item level metadata attribute name
MULTIVARIATE_OUTLIER_CHECKTYPECross-item level metadata attribute name
nresreturn the number of result slots in a report
pipeline_recursive_resultConvert a pipeline result data frame to named encapsulated...
pipeline_vectorizedCall (nearly) one "Accuracy" function with many...
plot.dataquieR_summaryPlot a 'dataquieR' summary
plus-.numeric_with_unitOperator caring for units
pow-.numeric_with_unitOperator caring for units
prep_acc_distributions_with_ecdfUtility function to plot a combined figure for distribution...
prep_add_cause_label_dfConvert missing codes in metadata format v1.0 and a...
prep_add_computed_variablesInsert missing codes for 'NA's based on rules
prep_add_data_framesAdd data frames to the pre-loaded / cache data frame...
prep_add_missing_codesInsert missing codes for 'NA's based on rules
prep_add_to_metaSupport function to augment metadata during data quality...
prep_apply_codingRe-Code labels with their respective codes according to the...
prep_check_for_dataquieR_updatesCheck for package updates
prep_check_meta_data_dataframeVerify and normalize metadata on data frame level
prep_check_meta_data_segmentVerify and normalize metadata on segment level
prep_check_meta_namesChecks the validity of metadata w.r.t. the provided column...
prep_clean_labelsSupport function to scan variable labels for applicability
prep_combine_report_summariesCombine two report summaries
prep_compare_meta_with_studyVerify item-level metadata
prep_create_metaSupport function to create data.frames of metadata
prep_create_meta_data_fileInstantiate a new metadata file
prep_create_storr_factoryCreate a factory function for 'storr' objects for backing a...
prep_datatype_from_dataGet data types from data
prep_deparse_assignmentsConvert two vectors from a code-value-table to a key-value...
prep_dq_data_type_ofGet the dataquieR 'DATA_TYPE' of 'x'
prep_expand_codesExpand code labels across variables
prep_extract_cause_label_dfExtract all missing/jump codes from metadata and export a...
prep_extract_classes_by_functionsExtract old function based summary from data quality results
prep_extract_summaryExtract summary from data quality results
prep_extract_summary.dataquieR_resultExtract report summary from reports
prep_extract_summary.dataquieR_resultset2Extract report summary from reports
prep_fix_meta_id_dupsFix metadata duplicates
prep_get_data_frameRead data from files/URLs
prep_get_labelsFetch a label for a variable based on its purpose
prep_get_study_data_segmentGet data frame for a given segment
prep_get_user_nameReturn the logged-in User's Full Name
prep_get_variantGet machine variant for snapshot tests
prep_guess_encodingGuess encoding of text or text files
prep_link_escapePrepare a label as part of a link for 'RMD' files
prep_list_dataframesList Loaded Data Frames
prep_list_vocAll valid voc: vocabularies
prep_load_folder_with_metadataPre-load a folder with named (usually more than) one table(s)
prep_load_reportLoad a 'dq_report2'
prep_load_report_from_backendLoad a report from a back-end
prep_load_workbook_like_filePre-load a file with named (usually more than) one table(s)
prep_map_labelsSupport function to allocate labels to variables
prep_merge_study_dataMerge a list of study data frames to one (sparse) study data...
prep_meta_data_v1_to_item_level_meta_dataConvert item-level metadata from v1.0 to v2.0
prep_min_obs_levelSupport function to identify the levels of a process variable...
prep_open_in_excelOpen a data frame in Excel
prep_pmapSupport function for a parallel 'pmap'
prep_prepare_dataframesPrepare and verify study data with metadata
prep_purge_data_frame_cacheClear data frame cache
prep_realize_ggplotMaterialize a lazy 'ggplot'
prep_remove_from_cacheRemove a specified element from the data frame cache
prep_render_pie_chart_from_summaryclasses_ggplot2Create a 'ggplot2' pie chart
prep_render_pie_chart_from_summaryclasses_plotlyCreate a 'plotly' pie chart
prep_robust_guess_data_typeGuess the data type of a vector
prep_save_reportSave a 'dq_report2'
prep_scalelevel_from_data_and_metadataHeuristics to amend a SCALE_LEVEL column and a UNIT column in...
prep_set_backendChange the back-end of a report
prep_study2metaGuess a metadata data frame from study data.
prep_summary_to_classesClassify metrics from a report summary table
prep_title_escapePrepare a label as part of a title text for 'RMD' files
prep_undiscloseRemove data disclosing details
prep_unsplit_val_tabsCombine all missing and value lists to one big table
prep_valuelabels_from_dataGet value labels from data
print.dataquieR_resultPrint a dataquieR result returned by dq_report2
print.dataquieR_resultsetGenerate a RMarkdown-based report from a dataquieR report
print.dataquieR_resultset2Generate a HTML-based report from a dataquieR report
print.dataquieR_summaryPrint a 'dataquieR' summary
print.DataSlotPrint a 'DataSlot' object
print.intervalprint implementation for the class 'interval'
print.listprint a list of 'dataquieR_result' objects
print.master_resultPrint a 'master_result' object
print.numeric_with_unitPrint a number with unit
print.ReportSummaryTableprint implementation for the class 'ReportSummaryTable'
print.SlotPrint a 'Slot' object
print.StudyDataSlotPrint a 'StudyDataSlot' object
print.TableSlotPrint a 'TableSlot' object
print.util_pairs_ggplot_panelsPrint method for 'util_pairs_ggplot_panels' objects
pro_applicability_matrixCheck applicability of DQ functions on study data
progress_init_fktfunction to call on progress initialization
rbind.ReportSummaryTableCombine 'ReportSummaryTable' outputs
RELCOMPL_SPEEDCross-item level metadata attribute name
REL_VALCross-item level metadata attribute name
resnamesReturn names of result slots (e.g., 3rd dimension of...
resnames.dataquieR_resultset2Return names of result slots (e.g., 3rd dimension of...
RESPT_PER_ITEMCross-item level metadata attribute name
SCALE_ACRONYMCross-item level metadata attribute name TODO
SCALE_LEVELSScale Levels
SCALE_NAMECross-item level metadata attribute name TODO
SEGMENT_ID_REF_TABLESegment level metadata attribute name
SEGMENT_ID_TABLEDeprecated segment level metadata attribute name
SEGMENT_ID_VARSSegment level metadata attribute name
SEGMENT_MISSSegment level metadata attribute name
SEGMENT_PART_VARSSegment level metadata attribute name
SEGMENT_RECORD_CHECKSegment level metadata attribute name
SEGMENT_RECORD_COUNTSegment level metadata attribute name
SEGMENT_UNIQUE_IDSegment level metadata attribute name
SEGMENT_UNIQUE_ROWSSegment level metadata attribute name
slash-.numeric_with_unitOperator caring for units
SPLIT_CHARCharacter used by default as a separator in metadata such as...
study_dataData frame with the study data whose quality is being...
sub-.dataquieR_resultset2Get a subset of a 'dataquieR' 'dq_report2' report
subset-.dataquieR_resultset2Write to a report
sub-sub-.dataquieR_resultset2Get a single result from a dataquieR 2 report
sub-subset-.dataquieR_resultset2Set a single result from a dataquieR 2 report
summary.dataquieR_resultsetSummarize a dataquieR report
summary.dataquieR_resultset2Generate a report summary table
times-.numeric_with_unitOperator caring for units
TOTRESPTCross-item level metadata attribute name
UNIT_IS_COUNTIs a unit a count according to 'units::valid_udunits()'
UNIT_PREFIXESValid unit prefixes according to...
UNIT_PREFIX_FACTORSFactors related to unit prefixes...
UNITSValid unit symbols according to 'units::valid_udunits()'
UNIT_SOURCESMaturity stage of a unit according to...
util_filter_repsumDelete rows from summary table for 'SSI' or non-'SSI'...
util_generate_pages_from_reportConvert a dataquieR report v2 to a named list of web pages
util_html_for_dimsCreate a dynamic dimension related page for the report
util_html_for_varCreate a dynamic single variable page for the report
util_int_duplicate_content_dataframeCheck for duplicated content
util_int_duplicate_content_segmentCheck for duplicated content
util_int_duplicate_ids_dataframeCheck for duplicated IDs
util_int_duplicate_ids_segmentCheck for duplicated IDs
util_int_unexp_records_set_dataframeCheck for unexpected data record set
util_int_unexp_records_set_segmentCheck for unexpected data record set
util_op_numeric_with_unitOperator caring for units
util_translate_indicator_metricsTranslate standard column names to readable ones
value-slash-missing-listsData frame with labels for missing- and jump-codes #'...
VARATT_REQUIRE_LEVELSRequirement levels of certain metadata columns
VARIABLE_LISTCross-item level metadata attribute name
VARIABLE_LIST_ORDERCross-item level metadata attribute name TODO internal use,...
VARIABLE_ROLESVariable roles can be one of the following:
WELL_KNOWN_META_VARIABLE_NAMESWell-known metadata column names, names of metadata columns
dataquieR documentation built on Jan. 8, 2026, 5:08 p.m.