get_collection_id: get_collection_id

In DataInsightPartners/nevadaReportCardr: Connect to Nevada Report Card API

Description

get_collection_id returns the Nevada Report Card (NRC) collection id that is used to reference a collection of schools and/or districts when requesting data (e.g. assessment data, personnel data, etc.). This function is referenced internally by most of the other functions in the nrc package.

Usage

get_collection_id(org_ids)

Arguments

org_ids

A numeric vector of NRC organization ids. You can look them up for a school or district by using get_org_id(name). These can be viewed by looking at the nrc_orgs data frame that comes with the nrc package, View(nrc_orgs).

Value

returns a collection id for the set of organization ids provided.

Examples

# Get the collection id for all organizations (c18172)
get_collection_id(unique(nrc_orgs$id))

# Get the collection id for organizations in Clark County
get_collection_id(nrc_orgs$id[nrc_orgs$parent_id == 64827])

# Get the collection id for all the districts in Nevadda
get_collection_id(nrc_orgs$id[nrc_orgs$type == 'D'])

DataInsightPartners/nevadaReportCardr documentation built on May 7, 2019, 2:53 a.m.