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_publications(): Get publications

get_data_catalogue(): Get publication specific data set catalogue

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

preview_dataset(): Preview the raw CSV for an API data set

query_dataset(): Query a data set

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.

api_url(): Generate an EES API URL

api_url_pages(): EES API URL paging

api_url_query(): Generate URL code for API data query

http_request_error(): Contextualise http request errors

convert_api_filter_type(): Convert filter type to API filter type

parse_tourl_filter_in(): Create .in query string for URL queries

parse_tojson_filter(): Parse a combination-filter query to json

parse_tojson_filter_eq(): Parse a filter-equal type query to json

parse_tojson_filter_in(): Parse a filter-in type query to json

parse_tojson_geographies(): Parse geographies to json

parse_tojson_indicators(): Parse an indicator-in type query to json

parse_tojson_location(): Create json location search string from geographies

parse_tojson_params(): Create a json query

parse_tojson_time_periods(): Parse time_periods to json

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_location_ids(): Parse API meta to give the locations

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

Support for handling data sets from the API

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

get_dataset(): Query a data set using GET and a query URL

post_dataset(): Query a data set using POST and a query json

parse_api_dataset(): Parse contents of API data set json output

parse_sqids_filters(): Parse IDs in a set of filters

parse_sqids_indicators(): Parse IDs in a set of indicators

parse_sqids_locations(): Parse location sqids

Generate example IDs and data

These functions are used widely to create working example code and tests

example_data_raw(): Example raw data

example_geography_query(): Create an example geography-query data frame

example_id(): Example ID

example_json_query(): Create an example json query string

Validation functions

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

validate_api_version(): Validate API version

validate_ees_environment(): Validate EES environment

validate_ees_filter_type(): Validate filter type

validate_ees_id(): Validate element IDs

validate_page_size(): Validate page size

validate_time_periods(): Validate time periods

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