Package index • eesyapi

Primary API workflow tools for analysts

These are the functions we expect analysts will most likely want to use to connect to the EES API.

get_publication_catalogue(): Get publications

get_publication_datasets(): Get publication specific data set catalogue

get_meta(): Get a parsed version of the API response for a data set's meta data

Support for generating API URLs and interpreting responses

These functions are helpful for deriving urls and handling HTTP responses and are used widely by the API workflow functions.

example_id(): Example ID

api_url(): Generate an EES API URL

api_url_pages(): EES API URL paging

http_request_error(): Contextualise http request errors

Support for handling meta data from the API

These functions are used by get_meta() and included here for completeness.

get_meta_response(): Get the base API response for a data set's meta data

parse_meta_filter_columns(): Parse API meta to give the filter columns

parse_meta_filter_item_ids(): Parse API meta to give the filter item codes

parse_meta_indicator_columns(): Parse API meta to give the indicator columns

parse_meta_location_ids(): Parse API meta to give the locations

parse_meta_time_periods(): Parse API meta to give the time periods

Validation functions

These functions are used across the package to validate elements being passed as part of an API url or query.

validate_ees_id(): Validate element IDs

validate_page_size(): Validate page size

Warning functions

These functions are used across the package to flag potential issues in data retrieval from the API (may switch to these being non-exported functions in the future).

warning_max_pages(): Overshot maximum pages in results