mirror of https://github.com/msberends/AMR.git
118 lines
4.2 KiB
Plaintext
118 lines
4.2 KiB
Plaintext
|
% Generated by roxygen2: do not edit by hand
|
||
|
|
% Please edit documentation in R/av_property.R
|
||
|
|
\name{av_property}
|
||
|
|
\alias{av_property}
|
||
|
|
\alias{av_name}
|
||
|
|
\alias{av_cid}
|
||
|
|
\alias{av_synonyms}
|
||
|
|
\alias{av_tradenames}
|
||
|
|
\alias{av_group}
|
||
|
|
\alias{av_atc}
|
||
|
|
\alias{av_loinc}
|
||
|
|
\alias{av_ddd}
|
||
|
|
\alias{av_ddd_units}
|
||
|
|
\alias{av_info}
|
||
|
|
\alias{av_url}
|
||
|
|
\title{Get Properties of an Antiviral Agent}
|
||
|
|
\usage{
|
||
|
|
av_name(x, language = get_AMR_locale(), tolower = FALSE, ...)
|
||
|
|
|
||
|
|
av_cid(x, ...)
|
||
|
|
|
||
|
|
av_synonyms(x, ...)
|
||
|
|
|
||
|
|
av_tradenames(x, ...)
|
||
|
|
|
||
|
|
av_group(x, language = get_AMR_locale(), ...)
|
||
|
|
|
||
|
|
av_atc(x, ...)
|
||
|
|
|
||
|
|
av_loinc(x, ...)
|
||
|
|
|
||
|
|
av_ddd(x, administration = "oral", ...)
|
||
|
|
|
||
|
|
av_ddd_units(x, administration = "oral", ...)
|
||
|
|
|
||
|
|
av_info(x, language = get_AMR_locale(), ...)
|
||
|
|
|
||
|
|
av_url(x, open = FALSE, ...)
|
||
|
|
|
||
|
|
av_property(x, property = "name", language = get_AMR_locale(), ...)
|
||
|
|
}
|
||
|
|
\arguments{
|
||
|
|
\item{x}{any (vector of) text that can be coerced to a valid antiviral agent code with \code{\link[=as.av]{as.av()}}}
|
||
|
|
|
||
|
|
\item{language}{language of the returned text, defaults to system language (see \code{\link[=get_AMR_locale]{get_AMR_locale()}}) and can also be set with \code{getOption("AMR_locale")}. Use \code{language = NULL} or \code{language = ""} to prevent translation.}
|
||
|
|
|
||
|
|
\item{tolower}{a \link{logical} to indicate whether the first \link{character} of every output should be transformed to a lower case \link{character}.}
|
||
|
|
|
||
|
|
\item{...}{other arguments passed on to \code{\link[=as.av]{as.av()}}}
|
||
|
|
|
||
|
|
\item{administration}{way of administration, either \code{"oral"} or \code{"iv"}}
|
||
|
|
|
||
|
|
\item{open}{browse the URL using \code{\link[utils:browseURL]{utils::browseURL()}}}
|
||
|
|
|
||
|
|
\item{property}{one of the column names of one of the \link{antivirals} data set: \code{vector_or(colnames(antivirals), sort = FALSE)}.}
|
||
|
|
}
|
||
|
|
\value{
|
||
|
|
\itemize{
|
||
|
|
\item An \link{integer} in case of \code{\link[=av_cid]{av_cid()}}
|
||
|
|
\item A named \link{list} in case of \code{\link[=av_info]{av_info()}} and multiple \code{\link[=av_atc]{av_atc()}}/\code{\link[=av_synonyms]{av_synonyms()}}/\code{\link[=av_tradenames]{av_tradenames()}}
|
||
|
|
\item A \link{double} in case of \code{\link[=av_ddd]{av_ddd()}}
|
||
|
|
\item A \link{character} in all other cases
|
||
|
|
}
|
||
|
|
}
|
||
|
|
\description{
|
||
|
|
Use these functions to return a specific property of an antiviral agent from the \link{antivirals} data set. All input values will be evaluated internally with \code{\link[=as.av]{as.av()}}.
|
||
|
|
}
|
||
|
|
\details{
|
||
|
|
All output \link[=translate]{will be translated} where possible.
|
||
|
|
|
||
|
|
The function \code{\link[=av_url]{av_url()}} will return the direct URL to the official WHO website. A warning will be returned if the required ATC code is not available.
|
||
|
|
}
|
||
|
|
\section{Source}{
|
||
|
|
|
||
|
|
World Health Organization (WHO) Collaborating Centre for Drug Statistics Methodology: \url{https://www.whocc.no/atc_ddd_index/}
|
||
|
|
|
||
|
|
European Commission Public Health PHARMACEUTICALS - COMMUNITY REGISTER: \url{https://ec.europa.eu/health/documents/community-register/html/reg_hum_atc.htm}
|
||
|
|
}
|
||
|
|
|
||
|
|
\section{Reference Data Publicly Available}{
|
||
|
|
|
||
|
|
All data sets in this \code{AMR} package (about microorganisms, antibiotics, R/SI interpretation, EUCAST rules, etc.) are publicly and freely available for download in the following formats: R, MS Excel, Apache Feather, Apache Parquet, SPSS, SAS, and Stata. We also provide tab-separated plain text files that are machine-readable and suitable for input in any software program, such as laboratory information systems. Please visit \href{https://msberends.github.io/AMR/articles/datasets.html}{our website for the download links}. The actual files are of course available on \href{https://github.com/msberends/AMR/tree/main/data-raw}{our GitHub repository}.
|
||
|
|
}
|
||
|
|
|
||
|
|
\examples{
|
||
|
|
# all properties:
|
||
|
|
av_name("ACI")
|
||
|
|
av_atc("ACI")
|
||
|
|
av_cid("ACI")
|
||
|
|
av_synonyms("ACI")
|
||
|
|
av_tradenames("ACI")
|
||
|
|
av_group("ACI")
|
||
|
|
av_url("ACI")
|
||
|
|
|
||
|
|
# smart lowercase tranformation
|
||
|
|
av_name(x = c("ACI", "VALA"))
|
||
|
|
av_name(x = c("ACI", "VALA"), tolower = TRUE)
|
||
|
|
|
||
|
|
# defined daily doses (DDD)
|
||
|
|
av_ddd("ACI", "oral")
|
||
|
|
av_ddd_units("ACI", "oral")
|
||
|
|
av_ddd("ACI", "iv")
|
||
|
|
av_ddd_units("ACI", "iv")
|
||
|
|
|
||
|
|
av_info("ACI") # all properties as a list
|
||
|
|
|
||
|
|
# all av_* functions use as.av() internally, so you can go from 'any' to 'any':
|
||
|
|
av_atc("ACI")
|
||
|
|
av_group("J05AB01")
|
||
|
|
av_loinc("abacavir")
|
||
|
|
av_name("29113-8")
|
||
|
|
av_name(135398513)
|
||
|
|
av_name("J05AB01")
|
||
|
|
}
|
||
|
|
\seealso{
|
||
|
|
\link{antivirals}
|
||
|
|
}
|