R/degauss_menu.R

In degauss-org/dht: A Collection of Functions to Assist Building DeGAUSS Containers

#' create data for use in DeGAUSS menu
#'
#' @param core_lib_env a data.frame of info about the DeGAUSS core image
#' library created with `get_degauss_core_lib_env()`
#' @return data.frame of information about core images with arguments
#' separated into names and default values as well as an added example DeGAUSS command
#' @examples
#' dht:::create_degauss_menu_data()
#' @export
create_degauss_menu_data <- function(core_lib_env = get_degauss_core_lib_env()) {
  core_lib_env %>%
    dplyr::transmute(
      name = degauss_name,
      version = degauss_version,
      description = degauss_description,
      argument = gsub("(.*?) \\[default: .*?\\].*", "\\1", degauss_argument, perl = TRUE),
      argument_default = gsub(".*?\\[default: (.*?)\\].*", "\\1", degauss_argument, perl = TRUE),
      url = glue::glue("https://degauss.org/{degauss_name}")
    ) %>%
  dplyr::mutate(
    degauss_cmd =
      purrr::pmap_chr(
        list(image = name, version = version, argument = argument_default),
        make_degauss_command,
        docker_cmd = "docker"
      )
  )
}

#' DeGAUSS Menu
#'
#' Run an interactive shiny application to find geomarkers
#' available within DeGAUSS based on categories and input data
#' characteristics. At launch, it will
#' download the latest information about DeGAUSS images in
#' the core library.  Suggested DeGAUSS commands are
#' automatically created and displayed for use.
#' @return NULL
#' @export
degauss_menu <- function() {
  .Deprecated("please visit https://degauss.org/menu instead")
}