View source: R/state_summary.R
state_summary | R Documentation |
Provides summary information for assessed uses for an organization (State, Territory or Tribe) and Integrated Reporting Cycle. The Organization ID for the state, territory or tribe is required. If a Reporting Cycle isn't provided, the service will return the most recent cycle. If a reporting Cycle is provided, the service will return a summary for the requested cycle.
state_summary(
organization_id = NULL,
reporting_cycle = NULL,
tidy = TRUE,
.unnest = TRUE,
...
)
organization_id |
(character) Restricts results to the specified organization. required |
reporting_cycle |
(character) Filters the returned results to the specified 4 digit reporting cycle year. Typically even numbered years. Will return reporting data for all years prior to and including the reporting cycle by reporting cycle. optional |
tidy |
(logical) |
.unnest |
(logical) |
... |
list of curl options passed to |
If tidy = FALSE
the raw JSON string is
returned, else the JSON data is parsed and returned as a list of tibbles.
See domain_values to search values that can be queried.
## Not run:
## Get a list of tibbles summarizing assessed uses
state_summary(organization_id = "TDECWR", reporting_cycle = "2016")
## Returns the query as a JSON string instead
state_summary(organization_id = "TDECWR", reporting_cycle = "2016", tidy = FALSE)
## End(Not run)
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.