R/qgis-has.R

In paleolimbot/qgisprocess: Use 'QGIS' Processing Algorithms

#' Check availability of QGIS, a plugin, a provider or an algorithm
#'
#' `has_qgis()` checks whether the loaded qgisprocess cache is populated,
#' which means that a QGIS installation was accessible and responsive when
#' loading the package.
#' `qgis_has_plugin()`, `qgis_has_provider()` and `qgis_has_algorithm()` check
#' for the availability of one or several plugins, processing providers and
#' algorithms, respectively.
#' They are vectorized.
#'
#' @note
#' Only plugins that implement processing providers are supported.
#'
#' @returns A logical, with length 1 in case of `has_qgis()`.
#'
#' @family topics about reporting the QGIS state
#' @concept functions to manage and explore QGIS and qgisprocess
#'
#' @param algorithm A qualified algorithm name
#' (e.g., `"native:buffer"`).
#' Can be a vector of names.
#' @param provider A provider name (e.g., `"native"`).
#' Can be a vector of names.
#' @param plugin A plugin name (e.g., `"native"`).
#' Can be a vector of names.
#' @inheritParams qgis_path
#'
#' @examples
#' has_qgis()
#' if (has_qgis()) qgis_has_algorithm("native:filedownloader")
#' if (has_qgis()) qgis_has_provider("native")
#' if (has_qgis()) qgis_has_plugin(c("grassprovider", "processing_saga_nextgen"))
#'
#' @name has_qgis

#' @rdname has_qgis
#' @export
has_qgis <- function() {
  !is.null(qgisprocess_cache$path) &&
    !is.null(qgisprocess_cache$version) &&
    !is.null(qgisprocess_cache$algorithms) &&
    !is.null(qgisprocess_cache$plugins)
}

# @param action An action to take if the 'qgis_process' executable could not be
#   found.
#' @keywords internal
assert_qgis <- function(action = abort) {
  if (!has_qgis()) {
    action(
      paste0(
        "The 'qgis_process' command-line utility was either not found or\n",
        "did not fulfil the needs to build the package cache.\n",
        "Please run `qgis_configure()` to fix this and rebuild the cache.\n",
        "See its documentation if you need to preset the path of qgis_process."
      )
    )
  }
}


#' @rdname has_qgis
#' @export
qgis_has_plugin <- function(plugin, query = FALSE, quiet = TRUE) {
  assert_that(is.character(plugin))
  plugin %in% qgis_plugins(query = query, quiet = quiet)$name
}

#' @rdname has_qgis
#' @export
qgis_has_provider <- function(provider, query = FALSE, quiet = TRUE) {
  assert_qgis()
  as.character(provider) %in% unique(qgis_algorithms(query, quiet)$provider)
}

#' @rdname has_qgis
#' @export
qgis_has_algorithm <- function(algorithm, query = FALSE, quiet = TRUE) {
  assert_qgis()
  as.character(algorithm) %in% qgis_algorithms(query, quiet)$algorithm
}