sc_get: Get scorecard data.

Description Usage Arguments Obtain a key Examples

View source: R/get.R

Description

This function gets the College Scorecard data by compiling and converting all the previous piped output into a single URL string that is used to get the data.

Usage

1
sc_get(sccall, api_key, debug = FALSE, print_key_debug = FALSE)

Arguments

sccall

Current list of parameters carried forward from prior functions in the chain (ignore)

api_key

Personal API key requested from https://api.data.gov/signup stored in a string. If you first set your key using sc_key, then you may omit this parameter. A key set here will take precedence over any set in the environment (DATAGOV_API_KEY).

debug

Set to true to print and return API call (URL string) rather than make actual request. Should only be used when debugging calls.

print_key_debug

Only used when debug == TRUE. Default masks the api_key value. Set to TRUE to print the full API call string with the api_key unmasked.

Obtain a key

To obtain an API key, visit https://api.data.gov/signup

Examples

1
2
3
4
5
6
## Not run: 
sc_get('<API KEY IN STRING>')
key <- '<API KEY IN STRING>'
sc_get(key)

## End(Not run)

btskinner/rscorecard documentation built on Nov. 3, 2018, 11:28 p.m.