guess_ab_col, benchmarks

man/guess_ab_col.Rd

@@ -0,0 +1,37 @@
+% Generated by roxygen2: do not edit by hand
+% Please edit documentation in R/guess_ab_col.R
+\name{guess_ab_col}
+\alias{guess_ab_col}
+\title{Guess antibiotic column}
+\usage{
+guess_ab_col(tbl = NULL, col = NULL, verbose = FALSE)
+}
+\arguments{
+\item{tbl}{a \code{data.frame}}
+
+\item{col}{a character to look for}
+
+\item{verbose}{a logical to indicate whether additional info should be printed}
+}
+\description{
+This tries to find a column name in a data set based on information from the \code{\link{antibiotics}} data set. You can look for an antibiotic (trade) of abbreviation and it will search the data for any column containing a name or ATC code of that antibiotic.
+}
+\section{Read more on our website!}{
+
+\if{html}{\figure{logo.png}{options: height=40px style=margin-bottom:5px} \cr}
+On our website \url{https://msberends.gitlab.io/AMR} you can find \href{https://msberends.gitlab.io/AMR/articles/AMR.html}{a omprehensive tutorial} about how to conduct AMR analysis and find \href{https://msberends.gitlab.io/AMR/reference}{the complete documentation of all functions}, which reads a lot easier than in R.
+}
+
+\examples{
+df <- data.frame(amox = "S",
+                 tetr = "R")
+
+guess_ab_col(df, "amoxicillin")
+# [1] "amox"
+guess_ab_col(df, "J01AA07") # ATC code of Tetracycline
+# [1] "tetr"
+
+guess_ab_col(df, "J01AA07", verbose = TRUE)
+# using column `tetr` for col "J01AA07"
+# [1] "tetr"
+}