R/dist.R

In ropenscilabs/available: Check if the Title of a Package is Available, Appropriate and Interesting

#' Find five closest package names in terms of string distance
#'
#' @param name name of package
#' @param pkgs packages to compare with
#' @importFrom stringdist stringdist
#' @importFrom utils head
#'
pkg_name_dist <- function(name, pkgs) {
  if (is.data.frame(pkgs)) {
    distances <- stringdist::stringdist(name, pkgs[["pkg_name"]])

    cbind(
      utils::head(pkgs[order(distances), ]),
      distance = utils::head(distances[order(distances)])
    )
  } else {
    distances <- stringdist::stringdist(name, pkgs)

    data.frame(
      pkgs = utils::head(pkgs[order(distances)]),
      distance = utils::head(distances[order(distances)]),
      stringsAsFactors = FALSE
    )
  }
}