List relationships between RIO tables

This function provides an overview of all defined relationships between RIO tables.

Usage

rio_list_relations(
  from = NULL,
  to = NULL,
  pattern = NULL,
  include_metadata = FALSE
)

Arguments

from

Optional filter to show only relationships from a specific table.

to

Optional filter to show only relationships to a specific table.

pattern

Optional pattern to filter relationship descriptions.

include_metadata

Logical indicating whether to include relationship metadata. Default is FALSE.

Value

A dataframe with relationship information.

Examples

if (FALSE) { # \dontrun{
# List all table relationships
all_relations <- rio_list_relations()

# Filter relationships from the "onderwijslocaties" table
loc_relations <- rio_list_relations(from = "onderwijslocaties")

# Filter relationships between two specific tables
specific_relations <- rio_list_relations(
  from = "onderwijslocaties",
  to = "vestigingserkenningen"
)
} # }