Implement extensive support for antiviral agents support (#77)

R/ab.R

@@ -82,8 +82,8 @@
 #'
 #' # use ab_* functions to get a specific properties (see ?ab_property);
 #' # they use as.ab() internally:
-#' ab_name("J01FA01") # "Erythromycin"
-#' ab_name("eryt") # "Erythromycin"
+#' ab_name("J01FA01")
+#' ab_name("eryt")
 #'
 #' \donttest{
 #' if (require("dplyr")) {
@@ -650,3 +650,20 @@ generalise_antibiotic_name <- function(x) {
   x <- gsub("(/| AND | WITH | W/|[+]|[-])+", " ", x, perl = TRUE)
   x
 }
+
+get_translate_ab <- function(translate_ab) {
+  translate_ab <- as.character(translate_ab)[1L]
+  if (translate_ab %in% c("TRUE", "official")) {
+    return("name")
+  } else if (translate_ab %in% c(NA_character_, "FALSE")) {
+    return(FALSE)
+  } else {
+    translate_ab <- tolower(translate_ab)
+    stop_ifnot(translate_ab %in% colnames(AMR::antibiotics),
+               "invalid value for 'translate_ab', this must be a column name of the antibiotics data set\n",
+               "or TRUE (equals 'name') or FALSE to not translate at all.",
+               call = FALSE
+    )
+    translate_ab
+  }
+}