R/package.R

#' @include internal.R
NULL

#' @import shinyBS
#' @import promises
#' @import R6
#' @import sf
NULL

#' wheretowork: Systematic conservation planning application.
#'
#' The application is a decision support tool to help prioritize conservation
#' efforts for the Nature Conservancy of Canada. It provides an interactive
#' interface for conducting systematic conservation planning exercises, and
#' uses mathematical optimization algorithms to generate solutions.
#'
#' @name wheretowork
#'
#' @docType package
#' @aliases wheretowork-package
#'
#' @examples
#' \donttest{
#  # launch application
#' if (interactive()) {
#' run_app()
#' }
#' }
"_PACKAGE"

# define global variables to pass package checks
## these variables are used in lazy evaluation or the shiny application
utils::globalVariables(
  c(
    "absolute_area",
    "absolute_perimeter",
    "statistics",
    "session",
    "app_data",
    "project_data",
    "import_data",
    "user_groups",
    "."
  )
)

# ensure package checks pass
#' @importFrom R.utils gzip
#' @importFrom rcbc cbc_solve
#' @importFrom future future
#' @importFrom ipc stopMulticoreFuture
#' @importFrom plyr rbind.fill
#' @importFrom shinyalert shinyalert
#' @importFrom withr with_dir
#' @export
NULL
NCC-CNC/wheretowork documentation built on Feb. 27, 2025, 6:11 p.m.