R/SmarterScotland.R

In konradedgar/SmarterScotland: Source Public Data from statistics.gov.scot

#' @title SmarterScotland: Accessing opendata.gov.scot
#'
#' @description SmarterScotland provides a suite of convenience functions
#'   facilitating sourcing data from the
#'   \href{http://statistics.gov.scot}{statistics.gov.scot} portal.
#'
#'  \if{html}{\figure{logo.png}{options: alt="Smarter Scotland Logo" align="right"}}
#'
#' @details For sample usage see \code{vignette("basic-workflow", package = "SmarterScotland")}.
#'   For other usage, including charting and more advanced functionalities see
#'  \code{vignette("other-functions", package = "SmarterScotland")}.
#'
#'
#' @author \itemize{
#' \item Maintainer/Author: Konrad Zdeb \email{konrad.zdeb@@me.com}
#' }
#'
#' @section Acknowledgements:
#' The following package is written in the open (both metaphorically and literally as I tend do undertake this development as a leisure reactivity while working on the Glasgow - Edinburgh commuter train), with big thanks to the whole Open Source community that contributed useful input through their questions, answers, discussions and comments via StackOverflow, GitHub and R-Help.
#'
#' @section Package options:
#' \describe{
#' \item{\code{SmarterScotland.endpoint}}{Defaults to
#'   \code{http://statistics.gov.scot/sparql}. If need can be changed by
#'   modifying \code{options(SmarterScotland.endpoint = "new_value")}. It's
#'   highly unlikely that you will ever need to change this option.}
#'
#' \item{\code{SmarterScotland.response_check}}{Defaults to \code{warn}
#'   which results in warning if endpoint is not accessible. Other options are
#'   \code{stop} and \code{ignore} which respectively stop on errors or
#'   ignore checks.}
#'
#' \item{\code{SmarterScotland.geography_match_msg}}{Shows geography URIs for
#'   which there is match in the stored data set.}
#'
#'  \item{\code{SmarterScotland.suffix_rdf}}{When constructing URI appends
#'  \code{/rdfs:label} to selected strings. Defaults to \code{TRUE}; most likely
#'  you don't have a need to change this.}
#' }
#'
#' @useDynLib SmarterScotland, .registration = TRUE
#' @importFrom Rcpp sourceCpp
#' @importFrom checkmate assert_string test_character assertScalar assert_vector assert_character assert_data_frame
#' @importFrom httr POST accept_json warn_for_status stop_for_status content
#' @importFrom stats var setNames
#' @importFrom glue glue
#' @importFrom gtools smartbind
"_PACKAGE"

if (getRversion() >= "2.15.1") {
  utils::globalVariables(c("standard_geography_code_register"))
}