Package 'educationdata'

Title: Retrieve Records from the Urban Institute's Education Data Portal API
Description: Allows R users to retrieve and parse data from the Urban Institute's Education Data API <https://educationdata.urban.org/> into a 'data.frame' for analysis.
Authors: Erika Tyagi [cre], Kyle Ueyama [aut], Andrew Martin [ctb] , The Urban Institute [cph]
Maintainer: Erika Tyagi <[email protected]>
License: MIT + file LICENSE
Version: 0.1.4
Built: 2025-01-25 05:19:49 UTC
Source: https://github.com/UrbanInstitute/education-data-package-r

Help Index

Obtain data from the Urban Institute Education Data Portal API

Description

Obtain data from the Urban Institute Education Data Portal API

Usage

get_education_data(
  level = NULL,
  source = NULL,
  topic = NULL,
  subtopic = NULL,
  by = NULL,
  filters = NULL,
  add_labels = FALSE,
  csv = FALSE,
  verbose = TRUE
)

Arguments

level

API data level to query
source

API data source to query
topic

API data topic to query
subtopic

Optional 'list' of grouping parameters to pass to an API call
by

DEPRECATED in favor of 'subtopic'
filters

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

Add variable labels (when applicable)? Defaults to FALSE.
csv

Download the full csv file? Defaults to FALSE.
verbose

Print messages and warnings? Defaults to TRUE.

Value

A 'data.frame' of education data

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