R/pre_harmonize_names_sirius.R

Defines functions pre_harmonize_names_sirius

Documented in pre_harmonize_names_sirius

#' @title Pre harmonize names sirius
#'
#' @description This function pre harmonizes Sirius names
#'     to make them compatible
#'
#' @param x Character string containing a name
#'
#' @return Character string with the name modified according
#'    to the rules specified in the function
#'
#' @export
#'
#' @examples prepared_name <- pre_harmonize_names_sirius("My name/suffix")
pre_harmonize_names_sirius <- function(x) {
  ## Remove any characters after and including the '/' character from the name
  y <- x |>
    stringi::stri_replace_all_regex(
      pattern = "/.*",
      replacement = "",
      vectorize_all = FALSE
    )

  return(y)
}
taxonomicallyinformedannotation/tima-r documentation built on July 17, 2024, 7:11 p.m.