Print a human-readable description of each entity of a KPI metadata table (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_describe(
kpi_df,
max_n = 5,
format = "inline",
heading_level = 2,
sub_heading_level = heading_level + 1
)
A Kolada KPI metadata table
The maximum number of KPIs to describe.
Output format. Can be one of "inline" (default) or "md", i.e. 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.