R/get_informant_report.R
get_informant_report.Rd
We can get a table information report from an informant object that's
generated by the create_informant()
function. The report is provided as a
gt based display table. The amount of information shown depends on the
extent of that added via the use of the info_*()
functions or through
direct editing of a pointblank YAML file (an informant can be written
to pointblank YAML with yaml_write(informant = <informant>, ...)
).
get_informant_report( informant, size = "standard", title = ":default:", lang = NULL, locale = NULL )
informant | An informant object of class |
---|---|
size | The size of the display table, which can be either |
title | Options for customizing the title of the report. The default is
the keyword |
lang | The language to use for the information report (a summary table
that provides the validation plan and the results from the interrogation.
By default, |
locale | An optional locale ID to use for formatting values in the
information report summary table according the locale's rules. Examples
include |
A gt table object.
7-2
Other Incorporate and Report:
incorporate()
# Generate an informant object using # the `small_table` dataset informant <- create_informant(small_table) # This function creates some information # without any extra help by profiling # the supplied table object; it adds # the sections 'table' and columns' and # we can print the object to see the # table information report # Alternatively, we can get the same report # by using `get_informant_report()` report <- get_informant_report(informant) class(report)#> [1] "gt_tbl" "list"