rr_key: List registers linked to by key fields

In openregister/RegistersClientR: Use the UK Government Registers API

Description

Values in fields with the "register" proporty link to other registers. These functions list which registers are linked to by a field or all the fields in a register.

rr_key_fields() names which fields in a register have the "register" properety.

rr_key_links() names all fields in a register that have the "register" property, and the name of the register each one links to.

Usage

rr_key_fields(x)

## S3 method for class 'register'
rr_key_fields(x)

rr_key_links(x)

## S3 method for class 'register'
rr_key_links(x)

Arguments

x	Object of class "register", or a character vector that is a field of a register object (register$data$foo) with the "register" property.

Value

A character vector of names of registers that are linked to.

Examples

register <- rr_register("allergen")
rr_key_fields(register)
rr_key_links(register)

openregister/RegistersClientR documentation built on May 23, 2019, 9:03 p.m.