R/qgis_layertobookmarks.R

In JanCaha/r_package_qgis: An extension of package "qgisprocess" providing direct R functions for QGIS functions

##' QGIS Algorithm provided by QGIS (native c++) Convert layer to spatial bookmarks (native:layertobookmarks). Converts feature extents to stored spatial bookmarks. This algorithm creates spatial bookmarks corresponding to the extent of features contained in a layer.
##'
##' @title QGIS algorithm - Convert layer to spatial bookmarks
##'
##' @param INPUT `source` - Input layer. Path to a vector layer.
##' @param DESTINATION `enum`  of `("Project bookmarks", "User bookmarks")` - Bookmark destination. Number of selected option, e.g. '1'. Comma separated list of options, e.g. '1,3'.
##' @param NAME_EXPRESSION `expression` - Name field. A valid QGIS expression string, e.g "road_name" = 'MAIN RD'.
##' @param GROUP_EXPRESSION `expression` - Group field. A valid QGIS expression string, e.g "road_name" = 'MAIN RD'.
##' @param ... further parameters passed to `qgisprocess::qgis_run_algorithm()`
##' @param .complete_output logical specifying if complete out of `qgisprocess::qgis_run_algorithm()` should be used (`TRUE`) or first output (most likely the main) should read (`FALSE`). Default value is `TRUE`.
##' @param .quiet logical specifying if parameter `.quiet` for `qgisprocess::qgis_run_algorithm()` Default value is `TRUE`.
##' @param .messages logical specifying if messages from `qgisprocess::qgis_run_algorithm()` should be printed (`TRUE`) or not (`FALSE`). Default value is `FALSE`.
##'
##' @details
##' ## Outputs description
##' * COUNT - outputNumber - Count of bookmarks added
##'
##'
##' @export
##' @md
##' @importFrom qgisprocess qgis_run_algorithm

qgis_layertobookmarks <- function(INPUT = qgisprocess:::qgis_default_value(), DESTINATION = qgisprocess:::qgis_default_value(), NAME_EXPRESSION = qgisprocess:::qgis_default_value(), GROUP_EXPRESSION = qgisprocess:::qgis_default_value(),..., .complete_output = .complete_output_option(), .quiet = .quiet_option(), .messages = .message_option()) {

  check_algorithm_necessities("native:layertobookmarks")

  if (.messages){
    output <- qgisprocess::qgis_run_algorithm("native:layertobookmarks", `INPUT` = INPUT, `DESTINATION` = DESTINATION, `NAME_EXPRESSION` = NAME_EXPRESSION, `GROUP_EXPRESSION` = GROUP_EXPRESSION,..., .quiet = .quiet)
  } else {
    suppressMessages(
      output <- qgisprocess::qgis_run_algorithm("native:layertobookmarks", `INPUT` = INPUT, `DESTINATION` = DESTINATION, `NAME_EXPRESSION` = NAME_EXPRESSION, `GROUP_EXPRESSION` = GROUP_EXPRESSION,..., .quiet = .quiet)
      )
  }

  if (.complete_output) {
    return(output)
  }
  else{
    qgisprocess::qgis_extract_output(output, "COUNT")
  }
}