Skip to contents

Return reference table information, which may help with other searches

Source: R/get_reference_tbl.R
get_reference_tbl.Rd

Makes requests to the /referencetables/ endpoints and returns helpful reference tables. Reference tables can help identify valid inputs for querying CDSS API resources using cdssr. For more detailed information visit: https://dwr.state.co.us/rest/get/help#Datasets&#ReferenceTablesController&#gettingstarted&#jsonxml.

Usage

get_reference_tbl(table_name = NULL, api_key = NULL)

Arguments

table_name

character,name of the reference table to return. Must be one of: ("county", "waterdistricts", "waterdivisions", "designatedbasins", "managementdistricts", "telemetryparams", "climateparams", "divrectypes", "flags"). Defaults to NULL

api_key

character, API authorization token, optional. If more than maximum number of requests per day is desired, an API key can be obtained from CDSS.

Value

dataframe of CDSS endpoint Reference Table

Examples

if (FALSE) {
# Retrieve station flag reference table
flag_tbl <- get_reference_tbl(
   table_name = "flags"
   )

# Retrieve available telemetry station parameters
telemetry_params <- get_reference_tbl(
   table_name = "telemetryparams"
   )

# Retrieve available climate station parameters
climate_params <- get_reference_tbl(
   table_name = "climateparams"
   )

# Retrieve water districts
water_districts <- get_reference_tbl(
   table_name = "waterdistricts"
   )
}