R/utils_query_file.R

Defines functions query_file

Documented in query_file

#' @title Query File Utilities
#'
#' @description Small and handy utility functions usually not useful outside
#'   the package environment.
#'
#' @details The functions are used to find and import query files saved as
#'   \code{*.sparql} files. \code{\link{query_file}} is always used within
#'   \code{\link{read_query_file}}.
#'
#' @name query_file_functions
NULL

#' @rdname query_file_functions
#' @section query_file: Wrapper for the \code{\link[base]{system.file}} function
#'   passing path to a given query file and taking care of potentially missing
#'   extensions.
#' @param query_file_name Name of query file
query_file <- function(query_file_name) {
  system.file("sparql", {
    # Check for extension and append if missing
    if (!grepl("\\.sparql$", x = query_file_name, ignore.case = TRUE)) {
      paste0(query_file_name, ".sparql")
    } else {
      query_file_name
    }
  },
  package = "SmarterScotland",
  mustWork = TRUE)
}
konradedgar/SmarterScotland documentation built on Oct. 3, 2019, 11:46 a.m.