get_education_data_summary: Obtain data from the Urban Institute Education Data Portal...

View source: R/get_education_data_summary.R

get_education_data_summaryR Documentation

Obtain data from the Urban Institute Education Data Portal API summary endpoint functionality.

Description

Obtain data from the Urban Institute Education Data Portal API summary endpoint functionality.

Usage

get_education_data_summary(
  level,
  source,
  topic = NULL,
  subtopic = NULL,
  stat = NULL,
  var = NULL,
  by = NULL,
  filters = NULL
)

Arguments

level

API data level to query

source

API data source to query

topic

API data topic to query

subtopic

Optional additional parameters to pass to an API call. Only applicable to certain endpoints.

stat

Summary statistic to be calculated. Valid options

var

Variable to be summarized.

by

Variable(s) to group results by.

filters

Optional 'list' of query values to filter an API call

Value

A 'data.frame' of aggregated education data


UrbanInstitute/education-data-package-r documentation built on Sept. 30, 2024, 5:20 p.m.