prep_extract_summary: Extract summary from data quality results

View source: R/prep_extract_summary.R

prep_extract_summaryR Documentation

Extract summary from data quality results

Description

Generic function, currently supports dq_report2 and dataquieR_result

Usage

prep_extract_summary(r, ...)

Arguments

r

dq_report2 or dataquieR_result object

...

further arguments, maybe needed for some implementations

Value

list with two slots Data and Table with data.frames featuring all metrics columns from the report or result in x, the STUDY_SEGMENT and the VAR_NAMES. In case of Data, the columns are formatted nicely but still with the standardized column names – use util_translate_indicator_metrics() to rename them nicely. In case of Table, just as they are.

See Also

Other summary_functions: prep_combine_report_summaries(), prep_extract_classes_by_functions(), prep_extract_summary.dataquieR_result(), prep_extract_summary.dataquieR_resultset2(), prep_render_pie_chart_from_summaryclasses_ggplot2(), prep_render_pie_chart_from_summaryclasses_plotly(), prep_summary_to_classes(), util_as_cat(), util_extract_indicator_metrics(), util_get_category_for_result(), util_get_colors(), util_get_html_cell_for_result(), util_get_labels_grading_class(), util_get_message_for_result(), util_get_rule_sets(), util_get_ruleset_formats(), util_get_thresholds(), util_html_table(), util_melt_summary(), util_sort_by_order()


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