vz_get_register: Download and read school register

In petrbouchal/vsezved: Get data on Czech schools from <https://stistko.uiv.cz/registr/> and <https://data.msmt.cz/>

Download and read school register

Description

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.)

Usage

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

Arguments

nuts3_kod	used to point to per-region datasets; if left unset, defaults to state-wide data
url	URL; if left to NULL, will use internal default
tables	Which tables to return. Can be one or more of "organisations", "schools", "locations" or "specialisations" (specialisations not yet available via the package).
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.

petrbouchal/vsezved documentation built on July 14, 2024, 3:44 p.m.