This is the high-level function for getting data from the online XML export of the school register. It downloads the file (whole country by default) and turns it into a tibble, cleaning up names and dropping some uninteresting columns (this may change as the package matures.)

vz_get_register(
  package_id = NULL,
  url = NULL,
  tables = c("organisations", "schools", "locations", "specialisations"),
  write_file = TRUE,
  dest_dir = getwd()
)

Arguments

package_id

used to point to per-region datasets (see vz_list_registers()); if left unset, defaults to state-wide data

url

URL; if left to NULL, will use internal default

tables

CURRENTLY IGNORED; the first three tables are returned. Which tables to return. Can be one or more of "organisations", "schools", "locations" or "specialisations".

write_file

Whether to keep the downloaded XML file. Currently only writing to the working directory is supported.

dest_dir

Where to write the resulting XML

Value

a tibble or list of tibbles if multiple table names are passed to tables.