'HPZone' API Interface

[Up] [Top]

Documentation for package ‘HPZoneAPI’ version 1.0.0

Help Pages

HPZone_convert_dates Converts all relevant columns in the dataset to Date types.
HPZone_fields Endpoints and fields available in the HPZone API
HPZone_make_valid Takes a list of fields or endpoints and corrects them. This allows for short hand usage without having to check the documentation, e.g. 'Date of onset' instead of 'Date_of_onset'
HPZone_necessary_scope Determines the necessary scope for a given list of fields.
HPZone_request Performs a HPZone request with the given parameters.
HPZone_request_paginated Performs a HPZone request with the given parameters.
HPZone_request_query Performs a HPZone request with the given parameters.
HPZone_request_raw Performs a HPZone request with the given parameters.
HPZone_setup Initialisation function to define API credentials. This function must be called before anything else, as the details supplied in this call are required for use. Note that client_id and client_secret should preferably not be supplied in this call, but rather stored using [HPZone_store_credentials()].
HPZone_store_credentials Safely stores the HPZone API details, so you don't need to put them in your script. The default OS keyring backend is used through the keyring-package. Values are stored in an encrypted format to prevent harvesting by other applications. Note that the actual values are not supplied as arguments, but requested using rstudioapi password prompts.
test_HPZone_token Tests the supplied HPZone token against the token endpoint. Note that this does not check the type of access, only the functionality of the token.