The hardware and bandwidth for this mirror is donated by dogado GmbH, the Webhosting and Full Service-Cloud Provider. Check out our Wordpress Tutorial.
If you wish to report a bug, or if you are interested in having us mirror your free-software or open-source project, please feel free to contact us at mirror[@]dogado.de.

Type: Package
Title: Retrieve Records from the Urban Institute's Education Data Portal API
Version: 0.1.3
Date: 2022-09-29
URL: https://urbaninstitute.github.io/education-data-package-r/
BugReports: https://github.com/UrbanInstitute/education-data-package-r/issues
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.
Depends: R (≥ 3.4.0)
Imports: glue, httr, jsonlite, readr
License: MIT + file LICENSE
Encoding: UTF-8
RoxygenNote: 7.1.2
Suggests: knitr, rmarkdown, testthat
VignetteBuilder: knitr
NeedsCompilation: no
Packaged: 2022-09-29 13:29:36 UTC; etyagi
Author: Erika Tyagi [cre], Kyle Ueyama [aut], The Urban Institute [cph]
Maintainer: Erika Tyagi <etyagi@urban.org>
Repository: CRAN
Date/Publication: 2022-09-29 15:20:08 UTC

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
)

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.

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

These binaries (installable software) and packages are in development.
They may not be fully stable and should be used with caution. We make no claims about them.
Health stats visible at Monitor.