download_ipeds: Downloads IPEDS data for a given year.

In jbryer/ipeds: Integrated Postsecondary Education Data System (IPEDS) Access

Downloads IPEDS data for a given year.

Description

This function will download IPEDS data in MS Access file format. By default, files are downloaded to a subfolder of the ipeds package in the system's R library directory. Once downloaded, the MS Access database will be converted to a R data file for faster loading in subsequent R sessions.

Usage

download_ipeds(
  year = as.integer(format(Sys.Date(), "%Y")) - 1,
  dir = getIPEDSDownloadDirectory(),
  useProvisional = TRUE,
  force = FALSE,
  cleanup = FALSE,
  timeout = 300,
  ...
)

Arguments

year	the year of the survey
dir	the directory to download the data to. Defaults to the package directory.
useProvisional	if TRUE, provisional data files will be downloaded if the final version is not available.
force	if TRUE, the function will redownload the file.
cleanup	if TRUE, the zip and MS Access files will be deleted after the Rda file is created.
timeout	the amount of time, in milliseconds, to allow a file to download.
...	other parameters passed to url_exists.

Value

TRUE if the data has been successfully downloaded.

jbryer/ipeds documentation built on Feb. 25, 2023, 1:53 a.m.