pd_fields: A dataset's fields

View source: R/fields.R

pd_fieldsR Documentation

A dataset's fields

Description

What each field holds: its name, type and the publisher's description, with the range of a number or date and the values of a field that holds few. Read it before filtering with [pd_rows()], since a condition must name a field exactly and match its values exactly.

Usage

pd_fields(slug, version = NULL)

Arguments

slug

The dataset's slug, as in its page URL 'https://publicdata.au/d/<slug>/'.

version

A version date from [pd_versions()]. The newest when 'NULL'.

Value

A tibble with one row per field: 'name', 'type' ('"string"', '"integer"', '"number"', '"boolean"', '"date"' or '"datetime"'), 'description', 'min' and 'max' as text, and 'values', a list of the values a field holds when it holds few. For a database such as G-NAF there is a row per field of every table, with a 'table' column, and no ranges. Without ‘version' the fields are the newest version’s; a pinned version is described by its schema, without ranges or values.

See Also

Other metadata: pd_attribution(), pd_changes(), pd_cite(), pd_latest(), pd_provenance(), pd_schema(), pd_tables()

Examples


pd_fields("au-road-deaths")


publicdataau documentation built on Oct. 14, 2026, 5:07 p.m.