Download State Summaries

Provides summary information for assessed uses for an organization (State,Territory or Tribe) and Integrated Reporting Cycle. The Organization ID forthe state, territory or tribe is required. If a Reporting Cycle isn'tprovided, the service will return the most recent cycle. If a reporting Cycleis provided, the service will return a summary for the requested cycle.

Usage

state_summary(  organization_id=NULL,  reporting_cycle=NULL,  tidy=TRUE,  .unnest=TRUE,...)

Arguments

organization_id

(character) Restricts results to the specifiedorganization. required

reporting_cycle

(character) Filters the returned results to thespecified 4 digit reporting cycle year. Typically even numbered years. Willreturn reporting data for all years prior to and including the reportingcycle by reporting cycle. optional

tidy

(logical)TRUE (default) the function returns a tidiedtibble.FALSE the function returns the raw JSON string.

.unnest

(logical)TRUE (default) the function attempts to unnestdata to longest format possible. This defaults toTRUE for backwardscompatibility but it is suggested to useFALSE.

...

list of curl options passed tocrul::HttpClient()

Value

Iftidy = FALSE the raw JSON string isreturned, else the JSON data is parsed and returned as a list of tibbles.

Note

Seedomain_values to search values that can be queried.

Examples

if(FALSE){# \dontrun{## Get a list of tibbles summarizing assessed usesstate_summary(organization_id="TDECWR", reporting_cycle="2016")## Returns the query as a JSON string insteadstate_summary(organization_id="TDECWR", reporting_cycle="2016", tidy=FALSE)}# }