Reference

Every function, grouped as in the R package. Import the package as import georgiacivicdata as gcd.

Find data

datasets	List the datasets in the catalog.
search	Search the catalog.

Understand a dataset

describe	Describe a dataset or lookup table.
columns	Get a dataset's column dictionary.
contract	Get a dataset's data contract.
Description	Everything about one dataset, lookup table or geometry dataset.

Get data

rows	Get rows of a dataset.
values	List the category combinations a filter covers.

Lookup tables

dimension

Get the rows of a lookup table.

Geography and school zones

school_zones	Get school attendance zones.
district_boundaries	Get school district boundaries.
school_zone_status	Get each school's attendance-zone status.
school_zone_coverage	Get each district's attendance-zone coverage.
locate	Locate points or addresses.

Utilities

meta	Get the metadata carried by a result.
citation	Cite a dataset.
cache_clear	Clear the session cache and the disk cache.
set_option	Set a package option for the rest of the session.
get_option	Get the value of a package option.
option_context	Set options temporarily, inside a with block.

Errors and advisories

API errors keep the API's own code (such as "TOPIC_NOT_FOUND"), the HTTP status and the error's details. Catch GCDError for any of them, or a subclass for one kind of failure.

GCDError	Base class of every error from the Georgia Civic Data API or this package.
GCDNotFoundError	No such dataset, lookup table or path (HTTP 404).
GCDUnavailableError	The service couldn't answer: no connection, a timeout, a rate limit that outlasted the retries, or a server error (HTTP 5xx).
GCDPlaceNotFoundError	A district, school or county name matched nothing.
GCDPlaceAmbiguousError	A district, school or county name matched more than one place.
GCDCensusError	The U.S.
GCDAdvisory	An advisory about a result: suppressed values, totals that must not be added to their subgroups, a search with no good match, and so on.