Skip to contents

Downloads and combines enrollment data for multiple school years.

Usage

fetch_enr_multi(
  end_years,
  tidy = TRUE,
  use_cache = TRUE,
  source = NULL,
  max_age_days = NULL,
  refresh = FALSE,
  allow_partial = FALSE
)

Arguments

end_years

Vector of school year ends (e.g., c(2022, 2023, 2024))

tidy

If TRUE (default), returns data in long (tidy) format.

use_cache

If TRUE (default), uses locally cached data when available.

source

Requested acquisition mode: "package" (default) or explicit "live" where a runtime producer exists. Retained-only surfaces reject live requests; refresh their files through the documented manual harvest.

max_age_days

Maximum reusable live-cache age in elapsed 24-hour days.

refresh

Force live retrieval. Valid only in live mode.

allow_partial

If FALSE (default) the call FAILS CLOSED: any year that cannot be served aborts the whole request, so a short frame is never returned to a caller who did not ask for one. If TRUE, a year that the source genuinely could not serve is dropped with a warning naming it and recorded in the returned frame's missing_years attribute; a package or source-policy refusal is still never dropped. requested_years and missing_years are attached in both modes.

Value

Combined data frame with enrollment data for all requested years

Examples

if (FALSE) { # \dontrun{
# Get 3 years of recent data
enr_multi <- fetch_enr_multi(2022:2024)

# Track enrollment trends
enr_multi |>
  dplyr::filter(is_state, subgroup == "total_enrollment", grade_level == "TOTAL") |>
  dplyr::select(end_year, n_students)
} # }