This tag allows you to cite STATcubeR datasets in packages.
It Can be used by placing @STATcubeR followed by an id of an
open data dataset into roxygen comment blocks.
#' My Function
#' @STATcubeR OGD_f0743_VZ_HIS_GEM_4
#' @STATcubeR OGD_f0743_VZ_HIS_GEM_3
my_function() {
# ...
}
This will fetch metadata for the datasets and render the resuts into the documentation pages. The output of this example is shown at the end of this help page.
Details
It is recommended to set up persistent caching with
STATcubeR::od_cache_dir() when using this function.
It is planned to also support datasets from the STATcube REST API in the
future with something like the following syntax
#' @STATcubeR sc_table 'path/to/request.json'
#' @STATcubeR sc_example <example_id>``