R/guess_a_functions_package.R

In KoderKow/kowr: Utility Functions

#' @title Where is your home?
#'
#' @description  The primary use for this function is for its functionality via addin. The addin can be added as a shortcut; I set it as CMD+; for Mac and CTRL+; for Windows. This will search for possible packages a function belongs to, similar to `?function`. If there are multiple packages that have the same function, this function will favor any of tidyverse packages. This is due to myself generally using the tidyverse functions. If there are multiple tidyverse matchse, it picks the first package based on its alphabetic positioning. If there are no tidyverse packages and other packages, it will still pick the first package that shows up alphabetically.
guess_a_functions_package <- function() {
  usethis::ui_info("Looking for function, please leave the function highlighted ...")

  context <- rstudioapi::getActiveDocumentContext()
  id <- context$id
  selected_text <- context$selection[[1]]$text

  if (stringr::str_detect(selected_text, " ")) {
    usethis::ui_oops("Space(s) detected, please selection only the function name.")

    return(invisible(selected_text))
  }

  tidyverse_packages <- "kyle_was_here"
  tidy_pattern <- "i_like_avocados"

  ## incase, for some reason, tidyverse is not installed
  if ("tidyverse" %in% rownames(installed.packages())) {
    ## taken from tidyverse::tidyverse_packages(), I dont want to include as a dependency
    raw <- utils::packageDescription("tidyverse")$Imports

    imports <- strsplit(raw, ",")[[1]]

    parsed <- gsub("^\\s+|\\s+$", "", imports)

    tidyverse_packages <- vapply(strsplit(parsed, "\\s+"), "[[", 1, FUN.VALUE = character(1))

    tidy_pattern <- tidyverse_packages %>%
      stringr::str_c("^", ., "$", collapse = "|")
  }

  possible_packages <- help.search(
    pattern = paste0("^", selected_text, "$"),
    agrep = FALSE
  ) %>%
    purrr::pluck("matches", "Package") %>%
    unique()

  tidy_packages <- stringr::str_subset(possible_packages, tidy_pattern, negate = TRUE)

  possible_packages <- factor(
    x = possible_packages,
    levels = c(tidyverse_packages, tidy_packages)
  ) %>%
    .[order(.)]

  possible_package <- possible_packages %>%
    # stringr::str_subset("base", negate = TRUE) %>%
    .[1] %>%
    stringr::str_c(., "::", selected_text)

  if (is.na(possible_package)) {
    usethis::ui_oops("No packages could be found for this function.")

    return(invisible(selected_text))
  }

  usethis::ui_done("Function found!")

  rstudioapi::insertText(possible_package, id = id)
}