get_metadata_field: Get metadata

View source: R/metadata.R

get_metadata_fieldR Documentation

Get metadata

Description

Retrieve metadata from a dataset, such as contact information, notes, and official statistics status.

Usage

get_metadata_field(x, field)

get_metadata(x)

Arguments

x

A nisra_df object created using nisra_read_dataset()

field

The metadata field to read. See details for a list of fields.

Details

Every dataset should have the following metadata fields:

  • contact - contact name, email and phone

  • copyright - copyright information

  • experimental - a flag for experimental statistics

  • note - any notes describing the data

  • official - a flag for official statistics

  • subject - a code and label for the subject

  • updated - date

Value

Metadata if the field is found, otherwise NULL

Examples

mye <- nisra_read_dataset("MYE01T09")
get_metadata(mye)
get_metadata_field(mye, "contact")

nisrarr documentation built on June 8, 2025, 11:15 a.m.