describe: Describe Dimensions and Marginal Code Coverage

View source: R/structure.R

describeR Documentation

Describe Dimensions and Marginal Code Coverage

Description

Describe Dimensions and Marginal Code Coverage.

Usage

describe(OECDDatasetCode, import_labels = !wide, wide = FALSE,
         import_dim_labels = TRUE)

Arguments

OECDDatasetCode

A catalogue-resolved short code such as "CLI", a terminal ID such as "DF_CLI", a complete dataflow ID such as "DSD_STES@DF_CLI", or a qualified reference "OECD.SDD.STES,DSD_STES@DF_CLI" with an optional numeric version. Short codes are accepted only when resolution is unambiguous. An omitted version, "latest" or "+" selects the latest stable structure. See oecdDataset for resolution rules.

import_labels

Logical; include human-readable code labels. Defaults to the opposite of wide.

wide

Logical; collapse codes into one comma-separated string per dimension.

import_dim_labels

Logical; include descriptive dimension names.

Details

The coverage semantics and limitations are those of importMetabase. wide = TRUE requires import_labels = FALSE. Label and shape defaults follow the familiar eurodata workflow. Results are returned normally; assignment does not force an extra print side effect.

Value

A data.table. Long form contains Dim_name, Dim_val, optional Dim_name_label and Dim_val_label, and a logical membership column named exactly as the input dataset reference. Wide form uses Dim_values instead of Dim_val.

See Also

compare, importMetabase

Examples

if (interactive()) {
code <- "CLI"
describe(code)
describe(code, wide = TRUE)
}

OECDdata documentation built on Oct. 31, 2026, 1:07 a.m.