dataquieR2.5.1 package

Data Quality in Epidemiological Research

acc_cat_distributions

Plots and checks for distributions for categorical variables

acc_distributions_ecdf

ECDF plots for distribution checks

acc_distributions_loc

Plots and checks for distributions -- Location

acc_distributions_only

Plots and checks for distributions -- only

acc_distributions_prop

Plots and checks for distributions -- Proportion

acc_distributions

Plots and checks for distributions

acc_end_digits

Extension of acc_shape_or_scale to examine uniform distributions of en...

acc_loess

Smoothes and plots adjusted longitudinal measurements and longitudinal...

acc_margins

Estimate marginal means, see emmeans::emmeans

acc_multivariate_outlier

Calculate and plot Mahalanobis distances

acc_robust_univariate_outlier

Identify univariate outliers by four different approaches

acc_shape_or_scale

Compare observed versus expected distributions

acc_univariate_outlier

Identify univariate outliers by four different approaches

acc_varcomp

Utility function to compute model-based ICC depending on the (statisti...

API_VERSION

Version of the API

as.data.frame.dataquieR_resultset

Convert a full dataquieR report to a data.frame

as.list.dataquieR_resultset

Convert a full dataquieR report to a list

as.list.dataquieR_resultset2

inefficient way to convert a report to a list. try `prep_set_backend()...

ASSOCIATION_DIRECTION

Cross-item level metadata attribute name

ASSOCIATION_FORM

Cross-item level metadata attribute name

ASSOCIATION_METRIC

Cross-item level metadata attribute name

ASSOCIATION_RANGE

Cross-item level metadata attribute name

cash-.dataquieR_result

Extract elements of a dataquieR Result Object

cash-.dataquieR_resultset2

Access single results from a dataquieR_resultset2 report

cash-set-.dataquieR_resultset2

Write single results from a dataquieR_resultset2 report

CHECK_ID

Cross-item level metadata attribute name

CHECK_LABEL

Cross-item level metadata attribute name

check_table

Data frame with contradiction rules

CODE_CLASSES

types of value codes

CODE_LIST_TABLE

Default Name of the Table featuring Code Lists

CODE_ORDER

Only existence is checked, order not yet used

com_item_missingness

Summarize missingness columnwise (in variable)

com_qualified_item_missingness

Compute Indicators for Qualified Item Missingness

com_qualified_segment_missingness

Compute Indicators for Qualified Segment Missingness

com_segment_missingness

Summarizes missingness for individuals in specific segments

com_unit_missingness

Counts all individuals with no measurements at all

con_contradictions_redcap

Checks user-defined contradictions in study data

con_contradictions

Checks user-defined contradictions in study data

con_inadmissible_categorical

Detects variable levels not specified in metadata

con_inadmissible_vocabulary

Detects variable levels not specified in standardized vocabulary

con_limit_deviations

Detects variable values exceeding limits defined in metadata

contradiction_functions_descriptions

description of the contradiction functions

contradiction_functions

contradiction_functions

CONTRADICTION_TERM

Cross-item level metadata attribute name

CONTRADICTION_TYPE

Cross-item level metadata attribute name

DATA_PREPARATION

Cross-item level metadata attribute name

DATA_TYPES_OF_R_TYPE

All available data types, mapped from their respective R types

DATA_TYPES

Data Types

dataquieR_resultset_verify

Verify an object of class dataquieR_resultset

dataquieR_resultset

Internal constructor for the internal class dataquieR_resultset .

dataquieR_resultset2-class

Class dataquieR_resultset2 .

dataquieR.acc_loess.exclude_constant_subgroups

Exclude subgroups with constant values from LOESS figure

dataquieR.acc_loess.mark_time_points

Display time-points in LOESS plots

dataquieR.acc_loess.min_bw

Lower limit for the LOESS bandwidth

dataquieR.acc_loess.min_proportion

Lower limit for the proportion of cases or controls to create a smooth...

dataquieR.acc_loess.plot_format

default for Plot-Format in acc_loess()

dataquieR.acc_loess.plot_observations

Display observations in LOESS plots

dataquieR.acc_margins_num

Include number of observations for each level of the grouping variable...

dataquieR.acc_margins_sort

Sort levels of the grouping variable in the 'margins' figures

dataquieR.acc_multivariate_outlier.scale

Apply min-max scaling in parallel coordinates figure to inspect multiv...

dataquieR.col_con_con_empirical

Color for empirical contradictions

dataquieR.col_con_con_logical

Color for logical contradictions

dataquieR.CONDITIONS_LEVEL_TRHESHOLD

Log Level

dataquieR.CONDITIONS_WITH_STACKTRACE

Add stack-trace in condition messages (to be deprecated)

dataquieR.debug

Call browser() on errors

dataquieR.des_summary_hard_lim_remove

Removal of hard limits from data before calculating descriptive statis...

dataquieR.dontwrapresults

Disable automatic post-processing of dataquieR function results

dataquieR.ELEMENT_MISSMATCH_CHECKTYPE

Metadata describes more than the current study data

dataquieR.ERRORS_WITH_CALLER

Set caller for error conditions (to be deprecated)

dataquieR.fix_column_type_on_read

Try to avoid fallback to string columns when reading files

dataquieR.flip_mode

Flip-Mode to Use for figures

dataquieR.force_item_specific_missing_codes

Converting MISSING_LIST /JUMP_LIST to a MISSING_LIST_TABLE create on l...

dataquieR.force_label_col

Control, how the label_col argument is used.

dataquieR.GAM_for_LOESS

Enable to switch to a general additive model instead of LOESS

dataquieR.grading_formats

Name of the data.frame featuring a format for grading-values

dataquieR.grading_rulesets

Name of the data.frame featuring GRADING_RULESET

dataquieR.guess_missing_codes

Control, if dataquieR tries to guess missing-codes from the study da...

dataquieR.lang

Language-Suffix for metadata Label-Columns

dataquieR.max_group_var_levels_in_plot

Maximum number of levels of the grouping variable shown individually i...

dataquieR.max_group_var_levels_with_violins

Maximum number of levels of the grouping variable shown with individua...

dataquieR.MAX_LABEL_LEN

Maximum length for variable labels

dataquieR.MAX_VALUE_LABEL_LEN

Maximum length for value labels

dataquieR.MESSAGES_WITH_CALLER

Set caller for message conditions (to be deprecated)

dataquieR.min_obs_per_group_var_in_plot

Minimum number of observations per grouping variable that is required ...

dataquieR.MULTIVARIATE_OUTLIER_CHECK

Default availability of multivariate outlier checks in reports

dataquieR.non_disclosure

Remove all observation-level-real-data from reports

dataquieR.progress_fkt

function to call on progress increase

dataquieR.progress_msg_fkt

function to call on progress message update

dataquieR

The dataquieR package about Data Quality in Epidemiological Research

dataquieR.scale_level_heuristics_control_binaryrecodelimit

Number of levels to consider a variable ordinal in absence of SCALE_LE...

dataquieR.scale_level_heuristics_control_metriclevels

Number of levels to consider a variable metric in absence of SCALE_LEV...

dataquieR.testdebug

Disable all interactively used metadata-based function argument provis...

dataquieR.VALUE_LABELS_htmlescaped

Assume, all VALUE_LABELS are [HTML escaped](https://www.w3.org/Interna...

dataquieR.WARNINGS_WITH_CALLER

Set caller for warning conditions (to be deprecated)

des_scatterplot_matrix

Compute Pairwise Correlations

des_summary_categorical

Compute Descriptive Statistics - categorical variables

des_summary_continuous

Compute Descriptive Statistics - continuous variables

des_summary

Compute Descriptive Statistics

Descriptor

Descriptor Function

DF_CODE

Data frame level metadata attribute name

DF_ELEMENT_COUNT

Data frame level metadata attribute name

DF_ID_REF_TABLE

Data frame level metadata attribute name

DF_ID_VARS

Data frame level metadata attribute name

DF_NAME

Data frame level metadata attribute name

DF_RECORD_CHECK

Data frame level metadata attribute name

DF_RECORD_COUNT

Data frame level metadata attribute name

DF_UNIQUE_ID

Data frame level metadata attribute name

DF_UNIQUE_ROWS

Data frame level metadata attribute name

dim.dataquieR_resultset2

Get the dimensions of a dq_report2 result

dimensions

Names of DQ dimensions

dimnames.dataquieR_resultset2

Names of a dataquieR report object (v2.0)

dims

Dimension Titles for Prefixes

DISTRIBUTIONS

All available probability distributions for acc_shape_or_scale

dot-.indicator_or_descriptor

Holds Indicator .// Descriptor assignments from the manual at run-time

dot-.manual

Holds parts of the manual at run-time

dot-access_dq_rs2-set

Write elements from a dataquieR_resultset2

dot-access_dq_rs2

Access elements from a dataquieR_resultset2

dot-get_internal_api

Get Access to Utility Functions

dot-template_function_indicator

Roxygen-Template for indicator functions

dot-util_internal_normalize_meta_data

Make normalizations of v2.0 item_level metadata.

dot-variable_arg_roles

Variable-argument roles

dq_report_by

Generate a stratified full DQ report

dq_report

Generate a full DQ report

dq_report2

Generate a full DQ report, v2

GOLDSTANDARD

Cross-item level metadata attribute name

html_dependency_clipboard

HTML Dependency for report headers in clipboard

html_dependency_dataquieR

HTML Dependency for dataquieR

html_dependency_report_dt

HTML Dependency for report headers in DT::datatable

html_dependency_tippy

HTML Dependency for tippy

html_dependency_vert_dt

HTML Dependency for vertical headers in DT::datatable

Indicator

Indicator Function

int_all_datastructure_dataframe

Wrapper function to check for studies data structure

int_all_datastructure_segment

Wrapper function to check for segment data structure

int_datatype_matrix

Check declared data types of metadata in study data

int_duplicate_content

Check for duplicated content

int_duplicate_ids

Check for duplicated IDs

int_encoding_errors

Encoding Errors

int_part_vars_structure

Detect Expected Observations

int_sts_element_dataframe

Determine missing and/or superfluous data elements

int_sts_element_segment

Checks for element set

int_unexp_elements

Check for unexpected data element count

int_unexp_records_dataframe

Check for unexpected data record count at the data frame level

int_unexp_records_segment

Check for unexpected data record count within segments

int_unexp_records_set

Check for unexpected data record set

LONG_LABEL_EXCEPTION

An exception class assigned for exceptions caused by long variable lab...

menu_env_drop_down

Creates a drop-down menu

menu_env_menu_entry

Create a single menu entry

menu_env-menu

Generate the menu for a report

menu_env

.menu_env -- an environment for HTML menu creation

meta_data_cross

Well known columns on the meta_data_cross-item sheet

meta_data_dataframe

Well known columns on the meta_data_dataframe sheet

meta_data_env_co_vars

Extract co-variables for a given item

meta_data_env_criteria

Extract MULTIVARIATE_OUTLIER_CHECK for variable group

meta_data_env_group_vars

Extract group variables for a given item

meta_data_env_id_vars

Extract id variables for a given item or variable group

meta_data_env_n_rules

Extract outlier rules-number-threshold for a given item or variable gr...

meta_data_env_time_vars

Extract measurement time variable for a given item

meta_data_env

.meta_data_env -- an environment for easy metadata access

meta_data_segment

Well known columns on the meta_data_segment sheet

meta_data

Data frame with metadata about the study data on variable level

MULTIVARIATE_OUTLIER_CHECK

Cross-item level metadata attribute name

MULTIVARIATE_OUTLIER_CHECKTYPE

Cross-item level metadata attribute name

N_RULES

Cross-item and item level metadata attribute name

nres

return the number of result slots in a report

pipeline_recursive_result

Convert a pipeline result data frame to named encapsulated lists

pipeline_vectorized

Call (nearly) one "Accuracy" function with many parameterizations at o...

plot.dataquieR_summary

Plot a dataquieR summary

prep_acc_distributions_with_ecdf

Utility function to plot a combined figure for distribution checks

prep_add_cause_label_df

Convert missing codes in metadata format v1.0 and a missing-cause-tabl...

prep_add_computed_variables

Insert missing codes for NAs based on rules

prep_add_data_frames

Add data frames to the pre-loaded / cache data frame environment

prep_add_missing_codes

Insert missing codes for NAs based on rules

prep_add_to_meta

Support function to augment metadata during data quality reporting

prep_apply_coding

Re-Code labels with their respective codes according to the `meta_data...

prep_check_for_dataquieR_updates

Check for package updates

prep_check_meta_data_dataframe

Verify and normalize metadata on data frame level

prep_check_meta_data_segment

Verify and normalize metadata on segment level

prep_check_meta_names

Checks the validity of metadata w.r.t. the provided column names

prep_clean_labels

Support function to scan variable labels for applicability

prep_combine_report_summaries

Combine two report summaries

prep_compare_meta_with_study

Verify item-level metadata

prep_create_meta_data_file

Instantiate a new metadata file

prep_create_meta

Support function to create data.frame s of metadata

prep_create_storr_factory

Create a factory function for storr objects for backing a dataquieR_...

prep_datatype_from_data

Get data types from data

prep_deparse_assignments

Convert two vectors from a code-value-table to a key-value list

prep_dq_data_type_of

Get the dataquieR DATA_TYPE of x

prep_expand_codes

Expand code labels across variables

prep_extract_cause_label_df

Extract all missing/jump codes from metadata and export a cause-label-...

prep_extract_classes_by_functions

Extract old function based summary from data quality results

prep_extract_summary.dataquieR_result

Extract report summary from reports

prep_extract_summary.dataquieR_resultset2

Extract report summary from reports

prep_extract_summary

Extract summary from data quality results

prep_get_data_frame

Read data from files/URLs

prep_get_labels

Fetch a label for a variable based on its purpose

prep_get_study_data_segment

Get data frame for a given segment

prep_get_user_name

Return the logged-in User's Full Name

prep_get_variant

Get machine variant for snapshot tests

prep_guess_encoding

Guess encoding of text or text files

prep_link_escape

Prepare a label as part of a link for RMD files

prep_list_dataframes

List Loaded Data Frames

prep_list_voc

All valid voc: vocabularies

prep_load_folder_with_metadata

Pre-load a folder with named (usually more than) one table(s)

prep_load_report_from_backend

Load a report from a back-end

prep_load_report

Load a dq_report2

prep_load_workbook_like_file

Pre-load a file with named (usually more than) one table(s)

prep_map_labels

Support function to allocate labels to variables

prep_merge_study_data

Merge a list of study data frames to one (sparse) study data frame

prep_meta_data_v1_to_item_level_meta_data

Convert item-level metadata from v1.0 to v2.0

prep_min_obs_level

Support function to identify the levels of a process variable with min...

prep_open_in_excel

Open a data frame in Excel

prep_pmap

Support function for a parallel pmap

prep_prepare_dataframes

Prepare and verify study data with metadata

prep_purge_data_frame_cache

Clear data frame cache

prep_remove_from_cache

Remove a specified element from the data frame cache

prep_render_pie_chart_from_summaryclasses_ggplot2

Create a ggplot2 pie chart

prep_render_pie_chart_from_summaryclasses_plotly

Create a plotly pie chart

prep_robust_guess_data_type

Guess the data type of a vector

prep_save_report

Save a dq_report2

prep_scalelevel_from_data_and_metadata

Heuristics to amend a SCALE_LEVEL column and a UNIT column in the meta...

prep_set_backend

Change the back-end of a report

prep_study2meta

Guess a metadata data frame from study data.

prep_summary_to_classes

Classify metrics from a report summary table

prep_title_escape

Prepare a label as part of a title text for RMD files

prep_undisclose

Remove data disclosing details

prep_unsplit_val_tabs

Combine all missing and value lists to one big table

prep_valuelabels_from_data

Get value labels from data

print.dataquieR_result

Print a dataquieR result returned by dq_report2

print.dataquieR_resultset

Generate a RMarkdown-based report from a dataquieR report

print.dataquieR_resultset2

Generate a HTML-based report from a dataquieR report

print.dataquieR_summary

Print a dataquieR summary

print.DataSlot

Print a DataSlot object

print.interval

print implementation for the class interval

print.list

print a list of dataquieR_result objects

print.master_result

Print a master_result object

print.ReportSummaryTable

print implementation for the class ReportSummaryTable

print.Slot

Print a Slot object

print.StudyDataSlot

Print a StudyDataSlot object

print.TableSlot

Print a TableSlot object

pro_applicability_matrix

Check applicability of DQ functions on study data

rbind.ReportSummaryTable

Combine ReportSummaryTable outputs

REL_VAL

Cross-item level metadata attribute name

resnames.dataquieR_resultset2

Return names of result slots (e.g., 3rd dimension of dataquieR results...

resnames

Return names of result slots (e.g., 3rd dimension of dataquieR results...

SCALE_LEVELS

Scale Levels

SEGMENT_ID_REF_TABLE

Segment level metadata attribute name

SEGMENT_ID_TABLE

Deprecated segment level metadata attribute name

SEGMENT_ID_VARS

Segment level metadata attribute name

SEGMENT_MISS

Segment level metadata attribute name

SEGMENT_PART_VARS

Segment level metadata attribute name

SEGMENT_RECORD_CHECK

Segment level metadata attribute name

SEGMENT_RECORD_COUNT

Segment level metadata attribute name

SEGMENT_UNIQUE_ID

Segment level metadata attribute name

SEGMENT_UNIQUE_ROWS

Segment level metadata attribute name

SPLIT_CHAR

Character used by default as a separator in metadata such as missing c...

study_data

Data frame with the study data whose quality is being assessed

sub-.dataquieR_result

Extract Parts of a dataquieR Result Object

sub-.dataquieR_resultset2

Get a subset of a dataquieR dq_report2 report

sub-sub-.dataquieR_result

Extract Elements of a dataquieR Result Object

sub-sub-.dataquieR_resultset2

Get a single result from a dataquieR 2 report

sub-subset-.dataquieR_resultset2

Set a single result from a dataquieR 2 report

subset-.dataquieR_resultset2

Write to a report

summary.dataquieR_resultset

Summarize a dataquieR report

summary.dataquieR_resultset2

Generate a report summary table

UNIT_IS_COUNT

Is a unit a count according to units::valid_udunits()

UNIT_PREFIXES

Valid unit prefixes according to units::valid_udunits_prefixes()

UNIT_SOURCES

Maturity stage of a unit according to units::valid_udunits()

UNITS

Valid unit symbols according to units::valid_udunits()

UNIVARIATE_OUTLIER_CHECKTYPE

Item level metadata attribute name

util_3SD

Utility function for 3SD deviations rule

util_abbreviate_unique

Abbreviate a vector of strings

util_abbreviate

Abbreviate snake_case function names to shortened CamelCase

util_acc_loess_bin

Utility function for smoothed longitudinal trends from logistic regres...

util_acc_loess_continuous

Utility function for smoothes and plots adjusted longitudinal measurem...

util_acc_varcomp

Estimates variance components

util_adjust_data_type

Adjust the data types of study data, if needed

util_adjust_geom_text_for_plotly

Place all geom_texts also in plotly right from the x position

util_alias2caption

Create a caption from an alias name of a dq_report2 result

util_all_ind_functions

All indicator functions of dataquieR

util_all_intro_vars_for_rv

Get all PART_VARS for a response variable (from item-level metadata)

util_all_is_integer

convenience function to abbreviate all(util_is_integer(...))

util_anytime_installed

Test, if package anytime is installed

util_app_cd

utility function for the applicability of contradiction checks

util_app_con_contradictions_redcap

utility function for the applicability of contradiction checks

util_app_dc

utility function for the applicability of of distribution plots

util_app_dl

utility function to test for applicability of detection limits checks

util_app_ed

utility function for the applicability of of end digits preferences ch...

util_app_hl

utility function to test for applicability of hard limits checks

util_app_iac

utility function for the applicability of categorical admissibility

util_app_iav

utility function for the applicability of numeric admissibility

util_app_im

utility function applicability of item missingness

util_app_loess

utility function for applicability of LOESS smoothed time course plots

util_app_mar

utility function to test for applicability of marginal means plots

util_app_mol

utility function applicability of multivariate outlier detection

util_app_ol

utility function for the applicability of outlier detection

util_app_sl

utility function to test for applicability of soft limits checks

util_app_sm

utility function applicability of segment missingness

util_app_sos

utility function applicability of distribution function's shape or sca...

util_app_vc

utility applicability variance components

util_as_cat

Convert a category to an ordered factor (1:5)

util_as_integer_cat

Convert a category to a number (1:5)

util_as_numeric

Convert factors to label-corresponding numeric values

util_as_plotly_from_res

Return the pre-computed plotly from a dataquieR result

util_as_valid_missing_codes

Convert x to valid missing codes

util_assign_levlabs

utility function to assign labels to levels

util_attach_attr

Attach attributes to an object and return it

util_backtickQuote

utility function to set string in backticks

util_bar_plot

Utility function to create bar plots

util_bQuote

Put in back-ticks

util_cast_off

Data frame leaves haven

util_check_data_type

Verify the data type of a value

util_check_group_levels

Check data for observer levels

util_check_one_unique_value

Check for one value only

util_cll_nm2fkt_nm

Get Function called for a Call Name

util_col_description

Get description for a call

util_col2rgb

Return hex code colors from color names or STATAReporter syntax

util_collapse_msgs

Collect all errors, warnings, or messages so that they are combined fo...

util_combine_list_report_summaries

Create a data frame containing all the results from summaries of repor...

util_combine_res

Combine results for Single Variables

util_combine_value_label_tables

Combine two value lists

util_compare_meta_with_study

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

util_compress_ggplots_in_res

Remove specific classes from a ggplot plot_env environment

util_compute_kurtosis

Compute Kurtosis

util_compute_SE_skewness

Compute SE.Skewness

util_compute_skewness

Compute the Skewness

util_condition_constructor_factory

Produce a condition function

util_condition_from_try_error

Extract condition from try error

util_conversion_stable

Can a vector be converted to a defined DATA_TYPE

util_coord_flip

return a flip term for ggplot2 plots, if desired.

util_copy_all_deps

Copy default dependencies to the report's lib directory

util_correct_variable_use

Check referred variables

util_count_expected_observations

Count Expected Observations

util_create_page_file

Create an HTML file for the dq_report2

util_create_report_by_overview

Create an overview of the reports created with dq_report_by

util_dashboard_table

Create a dashboard-table from a report summary

util_data_type_conversion

Data type conversion

util_deparse1

Expression De-Parsing

util_detect_cores

Detect cores

util_df_escape

Escape characters for HTML in a data frame

util_dichotomize

Utility function to dichotomize variables

util_dist_selection

Utility function to characterize study variables

util_ds1_eval_env

Create an environment with several alias names for the study data vari...

util_empty

Test, if values of x are empty, i.e. NA or whitespace characters

util_ensure_character

convert a value to character

util_ensure_in

similar to match.arg

util_ensure_label

Utility function ensuring valid labels and variable names

util_ensure_suggested

Support function to stop, if an optional package is not installed

util_error

Produce an error message with a useful short stack trace. Then it stop...

util_eval_rule

Evaluate a parsed redcap rule for given study data

util_eval_to_dataquieR_result

Evaluate an expression and create a dataquieR_result object from it'...

util_evaluate_calls

Generate a full DQ report, v2

util_expect_data_frame

Verify, that argument is a data frame

util_expect_scalar

check, if a scalar/vector function argument matches expectations

util_extract_all_ids

Extract all ids from a list of htmltools objects

util_extract_indicator_metrics

Extract columns of a SummaryTable (or Segment, ...)

util_extract_matches

return all matches of an expression

util_filter_missing_list_table_for_rv

Filter a MISSING_LIST_TABLE for rows matching the variable rv

util_filter_names_by_regexps

Filter collection based on its names() using regular expressions

util_finalize_sizing_hints

Function that calculated height and width values for script_iframe

util_find_external_functions_in_stacktrace

Find externally called function in the stack trace

util_find_first_externally_called_functions_in_stacktrace

Find first externally called function in the stack trace

util_find_free_missing_code

Check, if x contains valid missing codes

util_find_indicator_function_in_callers

Search for a formal in the stack trace

util_find_var_by_meta

Try hard, to map a variable

util_first_row_to_colnames

Move the first row of a data frame to its column names

util_fix_merge_dups

Fix results from merge

util_fix_rstudio_bugs

RStudio crashes on parallel calls in some versions on Darwin based ope...

util_fix_sizing_hints

Ensure, sizing hint sticks at the dqr, only

util_fix_storr_object

Fix a storr object, if it features the factory-attribute

util_float_index_menu

return a single page navigation menu floating on the right

util_formattable

Plots simple HTML tables with background color scale

util_function_description

Get description for an indicator function

util_generate_anchor_link

Generate a link to a specific result

util_generate_anchor_tag

Generate a tag for a specific result

util_generate_calls_for_function

Generate function calls for a given indicator function

util_generate_calls

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

util_generate_pages_from_report

Convert a dataquieR report v2 to a named list of web pages

util_generate_table_indicators_descriptors

Create a table summarizing the number of indicators and descriptors in...

util_get_category_for_result

Return the category for a result

util_get_code_list

Fetch a missing code list from the metadata

util_get_colors

Get colors for each russet DQ category

util_get_concept_info

Read additional concept tables

util_get_encoding

Get encoding from metadata or guess it from data

util_get_fg_color

Find a foreground color for a background

util_get_hovertext

Import vector of hover text for tables in the report

util_get_labels_grading_class

Get labels for each russet DQ category

util_get_message_for_result

Return messages/warnings/notes/error messages for a result

util_get_redcap_rule_env

an environment with functions available for REDcap rules

util_get_rule_sets

Get rule sets for DQ grading

util_get_ruleset_formats

Get formats for DQ categories

util_get_storr_att_namespace

Get namespace for attributes

util_get_storr_object_from_report

Get the storr object backing a report

util_get_storr_summ_namespace

Get namespace specifically for summary attributes for speed-up

util_get_thresholds

Get the thresholds for grading

util_get_var_att_names_of_level

Get variable attributes of a certain provision level

util_get_vars_in_segment

Return all variables in the segment segment

util_get_voc_tab

Get the Table with Known Vocabularies

util_gg_var_label

Add labels to ggplot

util_has_no_group_vars

Utility function to check whether a variable has no grouping variable ...

util_heatmap_1th

Utility Function Heatmap with 1 Threshold

util_hide_file_windows

If on Windows, hide a file

util_histogram

Utility function to create histograms

util_html_attr_quote_escape

escape "

util_html_for_dims

Create a dynamic dimension related page for the report

util_html_for_var

Create a dynamic single variable page for the report

util_html_table

The jack of all trades device for tables

util_hubert

utility function for the outliers rule of Hubert and Vandervieren 2008

util_iframe_it_if_needed

Make it scalable, if it is a figure

util_init_respum_tab

Extract all properties of a ReportSummaryTable

util_int_breaks_rounded

Integer breaks for ggplot2

util_int_duplicate_content_dataframe

Check for duplicated content

util_int_duplicate_content_segment

Check for duplicated content

util_int_duplicate_ids_dataframe

Check for duplicated IDs

util_int_duplicate_ids_segment

Check for duplicated IDs

util_int_unexp_records_set_dataframe

Check for unexpected data record set

util_int_unexp_records_set_segment

Check for unexpected data record set

util_interpret_limits

Utility function to interpret mathematical interval notation

util_is_integer

Check for integer values

util_is_na_0_empty_or_false

Detect falsish values

util_is_numeric_in

Create a predicate function to check for certain numeric properties

util_is_svg_object

Detect un-disclosed ggplot

util_is_try_error

Check, if x is a try-error

util_is_valid_missing_codes

Check, if x contains valid missing codes

util_load_manual

being called by the active binding function for .manual

util_looks_like_missing

Check for repetitive values using the digits 8 or 9 only

util_make_data_slot_from_table_slot

Rename columns of a SummaryTable (or Segment, ...) to look nice

util_map_all

Maps label column metadata on study data variable names

util_map_by_largest_prefix

Map based on largest common prefix

util_map_labels

Support function to allocate labels to variables

util_margins_bin

Utility function to create a margins plot for binary variables

util_margins_lm

Utility function to create a margins plot from linear regression model...

util_margins_nom

Utility function to create a plot similar to the margins plots for nom...

util_margins_ord

Utility function to create a plot similar to the margins plots for ord...

util_margins_poi

Utility function to create a margins plot from Poisson regression mode...

util_match_arg

dataquieR version of match.arg

util_merge_data_frame_list

Combine data frames by merging

util_message

Produce a condition message with a useful short stack trace.

util_no_value_labels

Select really numeric variables

util_normalize_clt

Distribute CODE_LIST_TABLE in item level metadata

util_normalize_cross_item

Normalize and check cross-item-level metadata

util_normalize_value_labels

Convert VALUE_LABELS to separate tables

util_observation_expected

Detect Expected Observations

util_observations_in_subgroups

Utility function observations in subgroups

util_online_ref

Creates a Link to our Website

util_optimize_histogram_bins

Utility function to compute and optimize bin breaks for histograms

util_optimize_sequence_across_time_var

Utility function to distribute points across a time variable

util_order_by_order

Get the order of a vector with general order given in some other vecto...

util_par_pmap

Utility function parallel version of purrr::pmap

util_parse_assignments

Utility function to parse assignments

util_parse_interval

Utility function to parse intervals

util_parse_redcap_rule

Interpret a REDcap-style rule and create an expression, that represe...

util_paste_with_na

Paste strings but keep NA

util_paste0_with_na

Paste strings but keep NA (paste0)

util_plot_categorical_vars

Utility function to create plots for categorical variables

util_plot_figure_no_plotly

Plot a ggplot2 figure without plotly

util_plot_figure_plotly

Plot a ggplot2 figure using plotly

util_plot_svg_to_uri

Replacement for htmltools::plotTag

util_plot2svg_object

Plot to un-disclosed ggplot object

util_plotly2svg_object

Plotly to un-disclosed ggplot object

util_prep_location_check

Utility function to prepare the metadata for location checks

util_prep_proportion_check

Utility function to prepare the metadata for proportion checks

util_pretty_print

Convert single dataquieR result to an htmltools compatible object

util_pretty_vector_string

Prepare a vector four output

util_rbind

Bind data frames row-based

util_really_rstudio

Can we really be sure to run RStudio

util_recode

Map a vector of values based on an assignment table

util_referred_vars

For a group of variables (original) the function provides all original...

util_remove_empty_rows

removes empty rows from x

util_remove_na_records

remove all records, that have at least one NA in any of the given va...

util_render_table_dataquieR_summary

Render a table summarizing dataquieR results

util_replace_codes_by_NA

Utility function to replace missing codes by NAs

util_replace_hard_limit_violations

Replace limit violations (HARD_LIMITS) by NAs

util_rio_import_list

Import list of data frames

util_rio_import

Import a data frame

util_round_to_decimal_places

Round number of decimal places to 3 if the values are between 0.001 an...

util_set_dQuoteString

Utility function to put strings in quotes

util_set_size

Attaches attributes about the recommended minimum absolute sizes to th...

util_set_sQuoteString

Utility function single quote string

util_setup_rstudio_job

Set up an RStudio job

util_sigmagap

Utility function outliers according to the rule of Huber et al.

util_sort_by_order

Sort a vector by order given in some other vector

util_split_val_tab

Split table with mixed code/missing lists to single tables

util_standardise_ordinal_codes

Compute something comparable from an ordered

util_startsWith_prefix._or_equals_prefix

String check for results/combined results

util_stop_if_not

Verify assumptions made by the code, that must be TRUE

util_storr_factory

Create a storr object with a storr_factory attribute

util_storr_object

Create a storr-object using the factory

util_string_is_not_categorical

Utility function for judging whether a character vector does not appea...

util_study_var2factor

Convert a study variable to a factor

util_sub_string_left_from_.

Get sub-string left from first .

util_sub_string_right_from_.

Get sub-string right from first .

util_suppress_output

Suppress any output to stdout using sink()

util_suppress_warnings

Suppress warnings conditionally

util_table_of_vct

Tabulate a vector

util_table_rotator

Rotate 1-row data frames to key-value data frames

util_translate_indicator_metrics

Translate standard column names to readable ones

util_translate

Get a translation

util_tukey

Utility function Tukey outlier rule

util_undisclose

Remove tables referred to by metadata and use SVG for most figures

util_unit2baseunit

Detect base unit from composite units

util_user_hint

Save a hint to the user during package load

util_validate_known_meta

Utility function verifying syntax of known metadata columns

util_validate_missing_lists

Validate code lists for missing and/or jump codes

util_validate_report_summary_table

Verify the class ReportSummaryTable

util_varcomp_robust

Utility function to compute the rank intraclass correlation

util_variable_references

Find all columns in item-level-metadata, that refer to some other vari...

util_verify_encoding

Verify encoding

util_verify_names

Test for likely misspelled data frame references

util_view_file

View a file in most suitable viewer

util_warn_unordered

Warn about a problem in varname, if x has no natural order

util_warning

Produce a warning message with a useful short stack trace.

value-slash-missing-lists

Data frame with labels for missing- and jump-codes #' Metadata about v...

VARATT_REQUIRE_LEVELS

Requirement levels of certain metadata columns

VARIABLE_LIST

Cross-item level metadata attribute name

VARIABLE_ROLES

Variable roles can be one of the following:

WELL_KNOWN_META_VARIABLE_NAMES

Well-known metadata column names, names of metadata columns

Data quality assessments guided by a 'data quality framework introduced by Schmidt and colleagues, 2021' <doi:10.1186/s12874-021-01252-7> target the data quality dimensions integrity, completeness, consistency, and accuracy. The scope of applicable functions rests on the availability of extensive metadata which can be provided in spreadsheet tables. Either standardized (e.g. as 'html5' reports) or individually tailored reports can be generated. For an introduction into the specification of corresponding metadata, please refer to the 'package website' <https://dataquality.qihs.uni-greifswald.de/VIN_Annotation_of_Metadata.html>.

  • Maintainer: Stephan Struckmann
  • License: BSD_2_clause + file LICENSE
  • Last published: 2025-03-05