rr_index: Index a register by CURIEs

In openregister/RegistersClientR: Use the UK Government Registers API

Description

You can refer to records in a register by CURIEs of the form "prefix:reference", where the prefix is the name of the register, and the reference is a value in a field of the register. rr_index() indexes records by these CURIES.

Usage

rr_index(register, key = NULL)

Arguments

register	An object of class "register".
key	Character, the name of the field to use as theh reference part of the CURIE. If ommitted (default) then the 'key' field of the register is used (the field with the same name as the register, that is guaranteed to have unique values)

Examples

country <- rr_register("country")
rr_index(country, "start-date")
rr_index(country, "end-date")
rr_index(country)
rr_index(rr_register("local-authority-eng"), "local-authority-type")

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