Print a human-readable description of each row of a KPI Group metadata table, including member KPIs (up to a maximum number of rows). Can be printed either directly to the R console or used to populate a R markdown document, which can be useful for documentation purposes.
kpi_grp_describe(
kpi_grp_df,
max_n = 5,
format = "inline",
heading_level = 2,
sub_heading_level = heading_level + 1
)
A Kolada KPI Group metadata table, as created by e.g.
get_kpi_groups
.
The maximum number of KPI groups to describe.
Output format. Can be one of "inline" or "md" (markdown).
The top heading level output format is "md".
The sub heading level output format is "md".
Returns the object passed to the function, invisibly, to be re-used in a pipe.