municipality_grp_describe {rKolada}

Describe the municipalitie in a Kolada Municipality Group metadata table

Description

Print a human-readable description of each row of a Municipality Group metadata table, including member municipalities (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.

Usage

municipality_grp_describe(
  munic_grp_df,
  max_n = 5,
  format = "inline",
  heading_level = 2,
  sub_heading_level = heading_level + 1
)

Arguments

munic_grp_df

A Kolada Municipality Group metadata table, as created by e.g. get_municipality_groups.

max_n

The maximum number of KPI groups to describe.

format

Output format. Can be one of "inline" or "md" (markdown).

heading_level

The top heading level output format is "md".

sub_heading_level

The sub heading level output format is "md".

Value

Returns the object passed to the function, invisibly, to be re-used in a pipe.