{
  "_id": "6a105498acfb0bcc41ca2180",
  "Package": "HPZoneAPI",
  "Type": "Package",
  "Title": "'HPZone' API Interface",
  "Version": "1.3.0",
  "Authors@R": "person(\"Aart\", \"Dijkstra\", email=\"a.dijkstra@ggdnog.nl\", role=c(\"aut\", \"cre\", \"cph\"))",
  "Maintainer": "Aart Dijkstra <a.dijkstra@ggdnog.nl>",
  "Description": "Package that simplifies the use of the 'HPZone' API. Most\nof the annoying and labor-intensive parts of the interface are\nhandled by wrapper functions. Note that the API and its details\nare not publicly available. Information can be found at\n<https://www.ggdghorkennisnet.nl/groep/726-platform-infectieziekte-epidemiologen/documenten/map/9609>\nfor those with access.",
  "URL": "https://github.com/ggdatascience/HPZoneAPI",
  "BugReports": "https://github.com/ggdatascience/HPZoneAPI/issues",
  "License": "MIT + file LICENSE",
  "Encoding": "UTF-8",
  "LazyData": "true",
  "RoxygenNote": "7.3.3",
  "Config/testthat/edition": "3",
  "Config/pak/sysreqs": "libicu-dev libsecret-1-dev libsodium-dev libssl-dev",
  "Repository": "https://ggdatascience.r-universe.dev",
  "Date/Publication": "2026-04-09 10:09:20 UTC",
  "RemoteUrl": "https://github.com/ggdatascience/hpzoneapi",
  "RemoteRef": "HEAD",
  "RemoteSha": "648cccdb36e39f6d8839ccad6ac18f27e32ab9fe",
  "NeedsCompilation": "no",
  "Packaged": {
    "Date": "2026-05-09 08:27:30 UTC",
    "User": "root"
  },
  "Author": "Aart Dijkstra [aut, cre, cph]",
  "MD5sum": "c25c974eb155cbe180f0eb27872dfb5a",
  "_user": "ggdatascience",
  "_type": "src",
  "_file": "HPZoneAPI_1.3.0.tar.gz",
  "_fileid": "11e77cc75ca67a90ed4bce43f09417171872702fcdcd39111f737e44295510b8",
  "_filesize": 153819,
  "_sha256": "11e77cc75ca67a90ed4bce43f09417171872702fcdcd39111f737e44295510b8",
  "_created": "2026-05-09T08:27:30.000Z",
  "_published": "2026-05-22T13:05:28.407Z",
  "_distro": "noble",
  "_jobs": [
    {
      "job": 77385324593,
      "time": 129,
      "config": "linux-devel-x86_64",
      "r": "4.7.0",
      "check": "OK",
      "artifact": "6894318306"
    },
    {
      "job": 77385324734,
      "time": 134,
      "config": "linux-release-x86_64",
      "r": "4.6.0",
      "check": "OK",
      "artifact": "6894318871"
    },
    {
      "job": 77385324641,
      "time": 182,
      "config": "macos-oldrel-arm64",
      "r": "4.5.3",
      "check": "OK",
      "artifact": "6894319624"
    },
    {
      "job": 77385324915,
      "time": 133,
      "config": "macos-release-arm64",
      "r": "4.6.0",
      "check": "OK",
      "artifact": "6894315577"
    },
    {
      "job": 77385324409,
      "time": 170,
      "config": "source",
      "r": "4.6.0",
      "check": "OK",
      "artifact": "6894307087"
    },
    {
      "job": 77385324268,
      "time": 97,
      "config": "wasm-release",
      "r": "4.6.0",
      "check": "OK",
      "artifact": "7161188466"
    },
    {
      "job": 77385324866,
      "time": 93,
      "config": "windows-devel",
      "r": "4.7.0",
      "check": "OK",
      "artifact": "6894314974"
    },
    {
      "job": 77385325486,
      "time": 75,
      "config": "windows-oldrel",
      "r": "4.5.3",
      "check": "OK",
      "artifact": "6894313493"
    },
    {
      "job": 77385324804,
      "time": 77,
      "config": "windows-release",
      "r": "4.6.0",
      "check": "OK",
      "artifact": "6894313615"
    }
  ],
  "_buildurl": "https://github.com/r-universe/ggdatascience/actions/runs/25596455727",
  "_status": "success",
  "_host": "GitHub-Actions",
  "_upstream": "https://github.com/ggdatascience/hpzoneapi",
  "_commit": {
    "id": "648cccdb36e39f6d8839ccad6ac18f27e32ab9fe",
    "author": "Aart Dijkstra <aartdijkstra@gmail.com>",
    "committer": "Aart Dijkstra <aartdijkstra@gmail.com>",
    "message": "CRAN submission.\n",
    "time": 1775729360
  },
  "_maintainer": {
    "name": "Aart Dijkstra",
    "email": "a.dijkstra@ggdnog.nl"
  },
  "_registered": true,
  "_dependencies": [
    {
      "package": "R",
      "version": ">= 2.10",
      "role": "Depends"
    },
    {
      "package": "dplyr",
      "role": "Imports"
    },
    {
      "package": "httr2",
      "role": "Imports"
    },
    {
      "package": "jsonlite",
      "role": "Imports"
    },
    {
      "package": "keyring",
      "role": "Imports"
    },
    {
      "package": "lubridate",
      "role": "Imports"
    },
    {
      "package": "magrittr",
      "role": "Imports"
    },
    {
      "package": "readxl",
      "role": "Imports"
    },
    {
      "package": "rstudioapi",
      "role": "Imports"
    },
    {
      "package": "safer",
      "role": "Imports"
    },
    {
      "package": "stringr",
      "role": "Imports"
    },
    {
      "package": "testthat",
      "version": ">= 3.0.0",
      "role": "Suggests"
    }
  ],
  "_owner": "ggdatascience",
  "_selfowned": true,
  "_usedby": 0,
  "_updates": [
    {
      "week": "2026-04",
      "n": 2
    },
    {
      "week": "2026-15",
      "n": 4
    }
  ],
  "_tags": [
    {
      "name": "v1.1.0.9000",
      "date": "2026-01-23"
    }
  ],
  "_stars": 0,
  "_contributors": [
    {
      "user": "aartdijkstra",
      "count": 4,
      "uuid": 125073330
    }
  ],
  "_userbio": {
    "uuid": 51366690,
    "type": "organization",
    "name": "GGData"
  },
  "_downloads": {
    "count": 459,
    "source": "https://cranlogs.r-pkg.org/downloads/total/last-month/HPZoneAPI"
  },
  "_devurl": "https://github.com/ggdatascience/hpzoneapi",
  "_searchresults": 2,
  "_rbuild": "4.6.0",
  "_assets": [
    "extra/citation.cff",
    "extra/citation.html",
    "extra/citation.json",
    "extra/citation.txt",
    "extra/contents.json",
    "extra/HPZoneAPI.html",
    "extra/NEWS.html",
    "extra/NEWS.txt",
    "extra/readme.html",
    "extra/readme.md",
    "manual.pdf"
  ],
  "_homeurl": "https://github.com/ggdatascience/hpzoneapi",
  "_realowner": "ggdatascience",
  "_cranurl": true,
  "_releases": [
    {
      "version": "1.0.0",
      "date": "2025-10-28"
    },
    {
      "version": "1.1.0",
      "date": "2025-11-20"
    },
    {
      "version": "1.3.0",
      "date": "2026-04-09"
    }
  ],
  "_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"
  ],
  "_datasets": [
    {
      "name": "HPZone_fields",
      "title": "Endpoints and fields available in the HPZone API",
      "object": "HPZone_fields",
      "class": [
        "tbl_df",
        "tbl",
        "data.frame"
      ],
      "fields": [
        "endpoint",
        "field_hr",
        "field",
        "scope_standard",
        "scope_extended",
        "in_basic",
        "note"
      ],
      "rows": 248,
      "table": true,
      "tojson": true
    }
  ],
  "_help": [
    {
      "page": "HPZone_convert_dates",
      "title": "Converts all relevant columns in the dataset to Date types.",
      "topics": [
        "HPZone_convert_dates"
      ]
    },
    {
      "page": "HPZone_fields",
      "title": "Endpoints and fields available in the HPZone API",
      "topics": [
        "HPZone_fields"
      ]
    },
    {
      "page": "HPZone_make_valid",
      "title": "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'",
      "topics": [
        "HPZone_make_valid"
      ]
    },
    {
      "page": "HPZone_necessary_scope",
      "title": "Determines the necessary scope for a given list of fields.",
      "topics": [
        "HPZone_necessary_scope"
      ]
    },
    {
      "page": "HPZone_request",
      "title": "Performs a HPZone request with the given parameters.",
      "topics": [
        "HPZone_request"
      ]
    },
    {
      "page": "HPZone_request_paginated",
      "title": "Performs a HPZone request with the given parameters.",
      "topics": [
        "HPZone_request_paginated"
      ]
    },
    {
      "page": "HPZone_request_query",
      "title": "Performs a HPZone request with the given parameters.",
      "topics": [
        "HPZone_request_query"
      ]
    },
    {
      "page": "HPZone_request_raw",
      "title": "Performs a HPZone request with the given parameters.",
      "topics": [
        "HPZone_request_raw"
      ]
    },
    {
      "page": "HPZone_setup",
      "title": "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()].",
      "topics": [
        "HPZone_setup"
      ]
    },
    {
      "page": "HPZone_store_credentials",
      "title": "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.",
      "topics": [
        "HPZone_store_credentials"
      ]
    },
    {
      "page": "test_HPZone_token",
      "title": "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.",
      "topics": [
        "test_HPZone_token"
      ]
    }
  ],
  "_readme": "https://github.com/ggdatascience/hpzoneapi/raw/HEAD/README.md",
  "_rundeps": [
    "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",
    "rappdirs",
    "readxl",
    "rematch",
    "rlang",
    "rstudioapi",
    "safer",
    "sodium",
    "stringi",
    "stringr",
    "sys",
    "tibble",
    "tidyselect",
    "timechange",
    "utf8",
    "vctrs",
    "withr",
    "yaml"
  ],
  "_score": 3,
  "_indexed": true,
  "_nocasepkg": "hpzoneapi",
  "_universes": [
    "ggdatascience"
  ],
  "_binaries": [
    {
      "r": "4.7.0",
      "os": "linux",
      "version": "1.3.0",
      "date": "2026-05-09T08:29:33.000Z",
      "distro": "noble",
      "commit": "648cccdb36e39f6d8839ccad6ac18f27e32ab9fe",
      "fileid": "38d7b56e39a9797dd9899ad27d456f45575623b3f9f8bab43b957f7a2332e99a",
      "status": "success",
      "check": "OK",
      "buildurl": "https://github.com/r-universe/ggdatascience/actions/runs/25596455727"
    },
    {
      "r": "4.6.0",
      "os": "linux",
      "version": "1.3.0",
      "date": "2026-05-09T08:29:38.000Z",
      "distro": "noble",
      "commit": "648cccdb36e39f6d8839ccad6ac18f27e32ab9fe",
      "fileid": "ebde2aa18b1cddd333859e261cebd02d05043db93e6f0086207104d2bf840e06",
      "status": "success",
      "check": "OK",
      "buildurl": "https://github.com/r-universe/ggdatascience/actions/runs/25596455727"
    },
    {
      "r": "4.5.3",
      "os": "mac",
      "version": "1.3.0",
      "date": "2026-05-09T08:29:53.000Z",
      "commit": "648cccdb36e39f6d8839ccad6ac18f27e32ab9fe",
      "fileid": "c65e63ec5010ae7a420b15ad1b103c0c9c2eb6b7adbd39ec1b42def01178718d",
      "status": "success",
      "check": "OK",
      "buildurl": "https://github.com/r-universe/ggdatascience/actions/runs/25596455727"
    },
    {
      "r": "4.6.0",
      "os": "mac",
      "version": "1.3.0",
      "date": "2026-05-09T08:29:11.000Z",
      "commit": "648cccdb36e39f6d8839ccad6ac18f27e32ab9fe",
      "fileid": "b69fa991f093b5f564d6d8155ec229a3594a030b6bdbd6515a5b05f9955fc260",
      "status": "success",
      "check": "OK",
      "buildurl": "https://github.com/r-universe/ggdatascience/actions/runs/25596455727"
    },
    {
      "r": "4.7.0",
      "os": "win",
      "version": "1.3.0",
      "date": "2026-05-09T08:28:52.000Z",
      "commit": "648cccdb36e39f6d8839ccad6ac18f27e32ab9fe",
      "fileid": "c4c72266ee556c24c4862002259da4f9c08a4ee91244a55eb36a5006d7899c96",
      "status": "success",
      "check": "OK",
      "buildurl": "https://github.com/r-universe/ggdatascience/actions/runs/25596455727"
    },
    {
      "r": "4.5.3",
      "os": "win",
      "version": "1.3.0",
      "date": "2026-05-09T08:28:37.000Z",
      "commit": "648cccdb36e39f6d8839ccad6ac18f27e32ab9fe",
      "fileid": "c0df284ceff601358fa19b78cfb04004815948b9664d16f96310ff0ce8ce313c",
      "status": "success",
      "check": "OK",
      "buildurl": "https://github.com/r-universe/ggdatascience/actions/runs/25596455727"
    },
    {
      "r": "4.6.0",
      "os": "win",
      "version": "1.3.0",
      "date": "2026-05-09T08:28:38.000Z",
      "commit": "648cccdb36e39f6d8839ccad6ac18f27e32ab9fe",
      "fileid": "9eb3da003a97ccdfca389070f2966caecf35e842475873e1764bdc465e2b343a",
      "status": "success",
      "check": "OK",
      "buildurl": "https://github.com/r-universe/ggdatascience/actions/runs/25596455727"
    },
    {
      "r": "4.6.0",
      "os": "wasm",
      "version": "1.3.0",
      "date": "2026-05-22T13:05:09.000Z",
      "commit": "648cccdb36e39f6d8839ccad6ac18f27e32ab9fe",
      "fileid": "c715d5a95d7b1679404b1f64e2bd1a701ac995d465ec46b16f558c98e67a6ccc",
      "status": "success",
      "buildurl": "https://github.com/r-universe/ggdatascience/actions/runs/25596455727"
    }
  ]
}