AMR/man/atc_property.Rd

78 lines
2.6 KiB
Plaintext
Raw Normal View History

2018-02-21 11:52:31 +01:00
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/atc.R
\name{atc_property}
\alias{atc_property}
2018-06-19 10:05:38 +02:00
\alias{atc_groups}
\alias{atc_ddd}
2018-02-21 11:52:31 +01:00
\title{Properties of an ATC code}
\source{
\url{https://www.whocc.no/atc_ddd_alterations__cumulative/ddd_alterations/abbrevations/}
}
\usage{
atc_property(atc_code, property, administration = "O",
url = "https://www.whocc.no/atc_ddd_index/?code=\%s&showdescription=no")
2018-06-19 10:05:38 +02:00
atc_groups(atc_code, ...)
atc_ddd(atc_code, ...)
2018-02-21 11:52:31 +01:00
}
\arguments{
\item{atc_code}{a character or character vector with ATC code(s) of antibiotic(s)}
2018-06-19 10:05:38 +02:00
\item{property}{property of an ATC code. Valid values are \code{"ATC"}, \code{"Name"}, \code{"DDD"}, \code{"U"} (\code{"unit"}), \code{"Adm.R"}, \code{"Note"} and \code{groups}. For this last option, all hierarchical groups of an ATC code will be returned, see Examples.}
2018-02-21 11:52:31 +01:00
2018-06-19 10:05:38 +02:00
\item{administration}{type of administration when using \code{property = "Adm.R"}, see Details}
2018-02-21 11:52:31 +01:00
\item{url}{url of website of the WHO. The sign \code{\%s} can be used as a placeholder for ATC codes.}
2018-06-19 10:05:38 +02:00
\item{...}{parameters to pass on to \code{atc_property}}
2018-02-21 11:52:31 +01:00
}
\description{
2018-06-19 10:05:38 +02:00
Gets data from the WHO to determine properties of an ATC (e.g. an antibiotic) like name, defined daily dose (DDD) or standard unit. \cr \strong{This function requires an internet connection.}
2018-02-21 11:52:31 +01:00
}
\details{
2018-06-19 10:05:38 +02:00
Options for parameter \code{administration}:
2018-02-21 11:52:31 +01:00
\itemize{
\item{\code{"Implant"}}{ = Implant}
\item{\code{"Inhal"}}{ = Inhalation}
\item{\code{"Instill"}}{ = Instillation}
\item{\code{"N"}}{ = nasal}
\item{\code{"O"}}{ = oral}
\item{\code{"P"}}{ = parenteral}
\item{\code{"R"}}{ = rectal}
\item{\code{"SL"}}{ = sublingual/buccal}
\item{\code{"TD"}}{ = transdermal}
\item{\code{"V"}}{ = vaginal}
}
2018-06-19 10:05:38 +02:00
Abbreviations of return values when using \code{property = "U"} (unit):
2018-02-21 11:52:31 +01:00
\itemize{
\item{\code{"g"}}{ = gram}
\item{\code{"mg"}}{ = milligram}
\item{\code{"mcg"}}{ = microgram}
\item{\code{"U"}}{ = unit}
\item{\code{"TU"}}{ = thousand units}
\item{\code{"MU"}}{ = million units}
\item{\code{"mmol"}}{ = millimole}
\item{\code{"ml"}}{ = milliliter (e.g. eyedrops)}
}
}
2018-02-22 20:48:48 +01:00
\examples{
\donttest{
2018-06-19 10:05:38 +02:00
# What's the ATC of amoxicillin?
guess_atc("Amoxicillin")
# [1] "J01CA04"
# oral DDD (Defined Daily Dose) of amoxicillin
atc_property("J01CA04", "DDD", "O")
# parenteral DDD (Defined Daily Dose) of amoxicillin
atc_property("J01CA04", "DDD", "P")
atc_property("J01CA04", property = "groups") # search hierarchical groups of amoxicillin
# [1] "ANTIINFECTIVES FOR SYSTEMIC USE"
# [2] "ANTIBACTERIALS FOR SYSTEMIC USE"
# [3] "BETA-LACTAM ANTIBACTERIALS, PENICILLINS"
# [4] "Penicillins with extended spectrum"
2018-02-22 20:48:48 +01:00
}
}