AMR/man/guess_ab_col.Rd

65 lines
2.5 KiB
Plaintext
Raw Normal View History

2019-01-03 23:56:19 +01:00
% Generated by roxygen2: do not edit by hand
2019-01-11 20:37:23 +01:00
% Please edit documentation in R/guess_ab_col.R
\name{guess_ab_col}
\alias{guess_ab_col}
2019-01-03 23:56:19 +01:00
\title{Guess antibiotic column}
\usage{
2019-05-13 10:10:16 +02:00
guess_ab_col(x = NULL, search_string = NULL, verbose = FALSE)
2019-01-03 23:56:19 +01:00
}
\arguments{
\item{x}{a \code{\link{data.frame}}}
2019-01-03 23:56:19 +01:00
\item{search_string}{a text to search \code{x} for, will be checked with \code{\link[=as.ab]{as.ab()}} if this value is not a column in \code{x}}
2019-01-03 23:56:19 +01:00
\item{verbose}{a logical to indicate whether additional info should be printed}
}
2019-05-13 10:10:16 +02:00
\value{
A column name of \code{x}, or \code{NULL} when no result is found.
}
2019-01-03 23:56:19 +01:00
\description{
This tries to find a column name in a data set based on information from the \link{antibiotics} data set. Also supports WHONET abbreviations.
2019-05-31 14:40:15 +02:00
}
\details{
You can look for an antibiotic (trade) name or abbreviation and it will search \code{x} and the \link{antibiotics} data set for any column containing a name or code of that antibiotic. \strong{Longer columns names take precendence over shorter column names.}
2019-01-03 23:56:19 +01:00
}
\section{Maturing lifecycle}{
\if{html}{\figure{lifecycle_maturing.svg}{options: style=margin-bottom:5px} \cr}
The \link[AMR:lifecycle]{lifecycle} of this function is \strong{maturing}. The unlying code of a maturing function has been roughed out, but finer details might still change. We will strive to maintain backward compatibility, but the function needs wider usage and more extensive testing in order to optimise the unlying code.
}
2019-01-03 23:56:19 +01:00
\section{Read more on our website!}{
On our website \url{https://msberends.gitlab.io/AMR} you can find \href{https://msberends.gitlab.io/AMR/articles/AMR.html}{a tutorial} about how to conduct AMR analysis, the \href{https://msberends.gitlab.io/AMR/reference}{complete documentation of all functions} (which reads a lot easier than here in R) and \href{https://msberends.gitlab.io/AMR/articles/WHONET.html}{an example analysis using WHONET data}.
2019-01-03 23:56:19 +01:00
}
2019-01-11 20:37:23 +01:00
\examples{
df <- data.frame(amox = "S",
tetr = "R")
guess_ab_col(df, "amoxicillin")
# [1] "amox"
2019-05-10 16:44:59 +02:00
guess_ab_col(df, "J01AA07") # ATC code of tetracycline
2019-01-11 20:37:23 +01:00
# [1] "tetr"
guess_ab_col(df, "J01AA07", verbose = TRUE)
2019-05-13 10:10:16 +02:00
# Note: Using column `tetr` as input for "J01AA07".
2019-01-11 20:37:23 +01:00
# [1] "tetr"
2019-01-29 00:06:50 +01:00
# WHONET codes
df <- data.frame(AMP_ND10 = "R",
AMC_ED20 = "S")
guess_ab_col(df, "ampicillin")
# [1] "AMP_ND10"
guess_ab_col(df, "J01CR02")
# [1] "AMC_ED20"
2019-05-10 16:44:59 +02:00
guess_ab_col(df, as.ab("augmentin"))
2019-01-29 00:06:50 +01:00
# [1] "AMC_ED20"
2019-05-31 14:40:15 +02:00
# Longer names take precendence:
df <- data.frame(AMP_ED2 = "S",
AMP_ED20 = "S")
guess_ab_col(df, "ampicillin")
# [1] "AMP_ED20"
2019-01-11 20:37:23 +01:00
}