meta_frames: Structured PxWebApi v2 metadata
In PxWebApiData: PX-Web Data by API

meta_frames

R Documentation

Structured PxWebApi v2 metadata

Description

Structures selected parts of table metadata into data frames.

Usage

meta_frames(url_or_tableid, url_type = "ssb")

Arguments

`url_or_tableid`	A table id, a PxWebApi v2 URL to data or metadata, or previously retrieved metadata.
`url_type`	Currently two possibilities: "ssb" (Norwegian) or "ssb_en" (English).

Details

Metadata related to the categories of dimensional variables are returned as data frames, with additional information stored as attributes.

Value

A named list of data frames. Additional metadata is stored as attributes on the data frames. The data URL is stored in the comment attribute of the returned object.

Examples

metaframes <- meta_frames(7459, url_type = "ssb_en")

names(metaframes)

metaframes[["ContentsCode"]]
metaframes[["Kjonn"]]

# Extra information stored as an attribute on a data frame
attr(metaframes[["Region"]], "extra")[[1]][[1]]

# Code list information as a data frame stored as another attribute
attr(metaframes[["Region"]], "code_lists")

# Information about elimination possibilities
attr(metaframes[["Region"]], "elimination")
attr(metaframes[["ContentsCode"]], "elimination")
sapply(metaframes, attr, "elimination") # elimination info for all variables

PxWebApiData documentation built on Sept. 9, 2026, 5:07 p.m.