{"Package":"gdldata","Title":"'Global Data Lab' R API","Version":"0.1","Authors@R":"c(\nperson(\"Global Data Lab\", email = \"info@globaldatalab.org\", role = \"cph\"),\nperson(\"Aaron\", \"van Geffen\", email = \"aaron.vangeffen@ru.nl\", role = c(\"aut\", \"cre\")))","Description":"Retrieve datasets from the 'Global Data Lab' website \ndirectly into R data frames. Functions are provided to reference available options\n(indicators, levels, countries, regions) as well.","Depends":"R (>= 3.4)","Imports":"httr2, methods","Suggests":"magrittr","URL":"https://docs.globaldatalab.org/gdldata/,\nhttps://github.com/GlobalDataLab/R-data-api","BugReports":"https://github.com/GlobalDataLab/R-data-api/issues","License":"MIT + file LICENSE","Encoding":"UTF-8","RoxygenNote":"7.2.3","NeedsCompilation":"no","Packaged":"2023-09-20 12:44:35 UTC; aaron","Author":"Global Data Lab [cph],\nAaron van Geffen [aut, cre]","Maintainer":"Aaron van Geffen ","Repository":"CRAN","Date/Publication":"2023-09-20 18:40:05 UTC","repoType":"cran","tarballUrl":"ftp://cran.r-project.org/pub/R/src/contrib/gdldata_0.1.tar.gz","jsonAuthors":[{"name":"Global Data Lab ","email":"info@globaldatalab.org","maintainer":false},{"name":"Aaron van Geffen","email":"aaron.vangeffen@ru.nl","maintainer":true}],"readme":"# gdldata\n\n[![CRAN Status](https://www.r-pkg.org/badges/version/gdldata)](https://cran.r-project.org/package=gdldata)\n\nRetrieve datasets from the Global Data Lab (GDL) website directly into R data frames.\nFunctions are provided to reference available options (indicators, regions, countries) as well.\n\n## Prerequisites\n\nTo work with the gdldata package, an API access token is required. Such a token may be created\nfor free on the [Global Data Lab website](https://globaldatalab.org). Simply log in, go to 'My GDL',\nand go to 'API Access'.\n\nNote that, by default, GDL only allows one active token per user. However, for academic purposes,\nthis limit may be increased, e.g. to facilitate classroom settings.\n\n## Installation\n\n```R\n# Install released version from CRAN\ninstall.packages(\"gdldata\")\n```\n\n```R\n# Install development version from GitHub\ndevtools::install_github(\"GlobalDataLab/R-data-api\")\n```\n\n## Usage\n\nTo get started, include the `gdldata` library:\n\n```R\nlibrary(gdldata)\n```\n\nThen create a GDL session object using your personal API access token, e.g.:\n\n```R\nsess <- gdl_session(\"SUBSTITUTE-WITH-YOUR-ACCESS-TOKEN\")\n```\n\nThis session object can be used to build your next API request, and facilitates partial request reuse.\nFor example, we can use it to retrieve the [IWI](https://globaldatalab.org/iwi/) indicator for India:\n\n```R\nsess <- set_indicator(sess, 'iwi')\nsess <- set_country(sess, 'IND')\niwi_india <- gdl_request(sess)\n```\n\nWe can reuse the same session object to retrieve more data. For example, we reuse it to retrieve several\n[SHDI](https://globaldatalab.org/shdi/) indicators for Belgium, Luxembourg, and The Netherlands:\n\n```R\nsess <- set_dataset(sess, 'shdi')\nsess <- set_countries(sess, c('BEL', 'LUX', 'NLD'))\nsess <- set_indicators(sess, c('healthindex', 'edindex', 'incindex'))\nshdi_benelux <- gdl_request(sess)\n```\n\n### Using pipes instead\n\nTo reduce verbosity, popular pipe operators may be used as well. You can either use the built-in\npipe operator `|>` (R >= 4.1) or use the `%>%` operator from [`magrittr`](https://magrittr.tidyverse.org/)\nas a substitute. Consider the following example:\n\n```R\nlibrary(magrittr)\n\nsess <- sess %>%\n set_dataset('shdi') %>%\n set_countries(c('BEL', 'LUX', 'NLD')) %>%\n set_indicators(c('healthindex', 'edindex', 'incindex')) %>%\nshdi_benelux <- gdl_request(sess)\n```\n\nNote that we could prepend `gdl_session()` and append `gdl_request()` to the pipe chain as well.\nHowever, to facilitate reuse of the session object, we recommend against this.\n\n### Additional reference functions\n\nThe GDL database may be explored fully without having to fall back to browsing the website.\nTo this end, we provide the following reference functions:\n```R\ngdl_indicators(session) # retrieves a list of indicators\ngdl_levels(session) # retrieves a list of aggregation levels\ngdl_countries(session) # retrieves a list of available countries\ngdl_regions(session, iso3) # retrieves a list of regions in a particular country\n```\n\n## Contributing\n\nWe welcome bug reports and feature requests in our [issue tracker](https://github.com/GlobalDataLab/R-data-api)\non GitHub.","jobInfo":{"package":"gdldata","version":"0.1","parsingStatus":"success","parserVersion":2,"parsedAt":"2025-09-01T19:29:49+0000"}}

Description

Arguments