Package: HPZoneAPI 1.3.0

Aart Dijkstra

HPZoneAPI: 'HPZone' API Interface

Package that simplifies the use of the 'HPZone' API. Most of the annoying and labor-intensive parts of the interface are handled by wrapper functions. Note that the API and its details are not publicly available. Information can be found at <https://www.ggdghorkennisnet.nl/groep/726-platform-infectieziekte-epidemiologen/documenten/map/9609> for those with access.

Authors:Aart Dijkstra [aut, cre, cph]

HPZoneAPI_1.3.0.tar.gz
HPZoneAPI_1.3.0.zip(r-4.7-any)HPZoneAPI_1.3.0.zip(r-4.6-any)HPZoneAPI_1.3.0.zip(r-4.5-any)
HPZoneAPI_1.3.0.tgz(r-4.6-any)HPZoneAPI_1.3.0.tgz(r-4.5-any)
HPZoneAPI_1.3.0.tar.gz(r-4.7-any)HPZoneAPI_1.3.0.tar.gz(r-4.6-any)
HPZoneAPI_1.3.0.tgz(r-4.6-emscripten)
manual.pdf |manual.html✨
DESCRIPTION |NEWS
card.svg |card.png
HPZoneAPI/json (API)

# Install 'HPZoneAPI' in R:

install.packages('HPZoneAPI', repos = c('https://ggdatascience.r-universe.dev', 'https://cloud.r-project.org'))

Bug tracker:https://github.com/ggdatascience/hpzoneapi/issues

Datasets:

HPZone_fields - Endpoints and fields available in the HPZone API

On CRAN:

3.00 score 2 scripts 288 downloads 10 exports 43 dependencies

Last updated from:648cccdb36. Checks:9 OK. Indexed: yes.

Target	Result	Time
linux-devel	OK	158
source / vignettes	OK	235
linux-release	OK	131
macos-release	OK	163
macos-oldrel	OK	127
windows-devel	OK	77
windows-release	OK	82
windows-oldrel	OK	84
wasm-release	OK	94

Exports:HPZone_convert_dates HPZone_make_valid HPZone_necessary_scope HPZone_request HPZone_request_paginated HPZone_request_query HPZone_request_raw HPZone_setup HPZone_store_credentials test_HPZone_token

Dependencies:askpass assertthat backports base64enc base64url cellranger cli cpp11 crayon curl dplyr filelock generics glue hms httr2 jsonlite keyring lifecycle lubridate magrittr openssl pillar pkgconfig prettyunits progress R6 readxl rematch rlang rstudioapi safer sodium stringi stringr sys tibble tidyselect timechange utf8 vctrs withr yaml

Citation

Development and contributors

Readme and manuals

Help Manual

Help page	Topics
Converts all relevant columns in the dataset to Date types.	HPZone_convert_dates
Endpoints and fields available in the HPZone API	HPZone_fields
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_make_valid
Determines the necessary scope for a given list of fields.	HPZone_necessary_scope
Performs a HPZone request with the given parameters.	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
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_setup
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.	HPZone_store_credentials
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.	test_HPZone_token