Print human-readable table summaries
Arguments
- table_df
A tibble returned by
get_tables().- max_n
Maximum number of tables to describe.
- format
Output format:
"inline"(console) or"md"(markdown).- heading_level
Heading level for output.
Examples
# \donttest{
scb <- px_api("scb", lang = "en")
if (px_available(scb)) {
get_tables(scb, query = "population") |> table_describe(max_n = 3)
}# }
#> ── TAB4552: Population connected to public network. Year 1960-2024 ──────────────
#> Subject: Environment > Water withdrawal and water use in Sweden > Water and wastewater services
#> Period: 1960 – 2024 (Annual)
#> Updated: 2026-06-02T06:00:00Z
#> Category: public
#> Variables: type of network, observations, year
#> Source: Statistics Sweden
#>
#> ── TAB6473: Population statistics by region and sex. Month 2025M01-2026M09 ─────
#> Subject: Population > Population statistics > Summary of vital events
#> Period: 2025M01 – 2026M09 (Monthly)
#> Updated: 2026-11-11T07:00:00Z
#> Category: public
#> Variables: region, population changes, sex, observations, month
#> Source: Statistics Sweden
#>
#> ── TAB1625: Population statistics by region and sex. Month 2000M01-2024M12 ──────
#> Subject: Population > Population statistics > Summary of vital events
#> Period: 2000M01 – 2024M12 (Monthly)
#> Updated: 2025-02-21T07:00:00Z
#> Category: public
#> Variables: region, population changes, sex, observations, month
#> Source: Statistics Sweden
#>
#> ... and 316 more table(s).