db_get: Function to query the live OR Extended database and return...

View source: R/db_get.R

db_getR Documentation

Function to query the live OR Extended database and return specific tables

Description

Function to query the live OR Extended database and return specific tables

Usage

db_get(table, db = NULL, raw = FALSE, key = db_key())

Arguments

table

A string specifying the specific table from the Oregon Extended live database. Should be one of "Accommodations", "Answers", "Districts", "Exams", "Items", "Preferences", "Schools", "Students", "Students_old", "Submissions", "SupplementalDistricts", "SupplementalSchools", "Tasks", "User", "UserStudents", or "UserStudents_old".

db

A string specifying the database to query. Defaults to NULL, in which case the most recent database is queried. These names should be specified either as a four digit year (e.g., 1718) or as in the database, e.g., "ORExt1718" would query the 1718 database.

raw

Logical, defaults to FALSE. Should the original tables from the database be returned? If FALSE, cleaned up names are returned and, for the "Items" table, item difficulties are returned instead of the full item attributes.

key

Your personal key for accessing the Oregon Extended Database. Defaults to db_key().

Value

tibble (if installed) or data.frame of requested table

Examples

library(orextdb)

## Not run: 
db_get(table = 'Schools', db = 'ORExt2021')

## End(Not run)

UO-BRT/orextdb documentation built on Jan. 29, 2023, 8:53 a.m.