# Get Properties of an Antiviral Drug
Use these functions to return a specific property of an antiviral drug
from the [antivirals](https://amr-for-r.org/reference/antimicrobials.md)
data set. All input values will be evaluated internally with
[`as.av()`](https://amr-for-r.org/reference/as.av.md).
## Usage
``` r
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
- x:
Any (vector of) text that can be coerced to a valid antiviral drug
code with [`as.av()`](https://amr-for-r.org/reference/as.av.md).
- language:
Language of the returned text - the default is system language (see
[`get_AMR_locale()`](https://amr-for-r.org/reference/translate.md))
and can also be set with the package option
[`AMR_locale`](https://amr-for-r.org/reference/AMR-options.md). Use
`language = NULL` or `language = ""` to prevent translation.
- tolower:
A [logical](https://rdrr.io/r/base/logical.html) to indicate whether
the first [character](https://rdrr.io/r/base/character.html) of every
output should be transformed to a lower case
[character](https://rdrr.io/r/base/character.html).
- ...:
Other arguments passed on to
[`as.av()`](https://amr-for-r.org/reference/as.av.md).
- administration:
Way of administration, either `"oral"` or `"iv"`.
- open:
Browse the URL using
[`utils::browseURL()`](https://rdrr.io/r/utils/browseURL.html).
- property:
One of the column names of one of the
[antivirals](https://amr-for-r.org/reference/antimicrobials.md) data
set: `vector_or(colnames(antivirals), sort = FALSE)`.
## Value
- An [integer](https://rdrr.io/r/base/integer.html) in case of
`av_cid()`
- A named [list](https://rdrr.io/r/base/list.html) in case of
`av_info()` and multiple `av_atc()`/`av_synonyms()`/`av_tradenames()`
- A [double](https://rdrr.io/r/base/double.html) in case of `av_ddd()`
- A [character](https://rdrr.io/r/base/character.html) in all other
cases
## Details
All output [will be
translated](https://amr-for-r.org/reference/translate.md) where
possible.
The function `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.
## Source
World Health Organization (WHO) Collaborating Centre for Drug Statistics
Methodology:
European Commission Public Health PHARMACEUTICALS - COMMUNITY REGISTER:
## Download Our Reference Data
All reference data sets in the AMR package - including information on
microorganisms, antimicrobials, and clinical breakpoints - are freely
available for download in multiple formats: R, MS Excel, Apache Feather,
Apache Parquet, SPSS, and Stata.
For maximum compatibility, we also provide machine-readable,
tab-separated plain text files suitable for use in any software,
including laboratory information systems.
Visit [our website for direct download
links](https://amr-for-r.org/articles/datasets.html), or explore the
actual files in [our GitHub
repository](https://github.com/msberends/AMR/tree/main/data-raw/datasets).
## See also
[antivirals](https://amr-for-r.org/reference/antimicrobials.md)
## Examples
``` r
# all properties:
av_name("ACI")
#> [1] "Aciclovir"
av_atc("ACI")
#> [1] "J05AB01"
av_cid("ACI")
#> [1] 135398513
av_synonyms("ACI")
#> [1] "acicloftal" "aciclovier" "aciclovirum"
#> [4] "activir" "acyclofoam" "acycloguanosine"
#> [7] "acyclovir" "acyclovir lauriad" "avaclyr"
#> [10] "cargosil" "cyclovir" "genvir"
#> [13] "gerpevir" "hascovir" "maynar"
#> [16] "novirus" "poviral" "sitavig"
#> [19] "sitavir" "vipral" "viropump"
#> [22] "virorax" "zovirax" "zyclir"
av_tradenames("ACI")
#> [1] "acicloftal" "aciclovier" "aciclovirum"
#> [4] "activir" "acyclofoam" "acycloguanosine"
#> [7] "acyclovir" "acyclovir lauriad" "avaclyr"
#> [10] "cargosil" "cyclovir" "genvir"
#> [13] "gerpevir" "hascovir" "maynar"
#> [16] "novirus" "poviral" "sitavig"
#> [19] "sitavir" "vipral" "viropump"
#> [22] "virorax" "zovirax" "zyclir"
av_group("ACI")
#> [1] "Nucleosides and nucleotides excl. reverse transcriptase inhibitors"
av_url("ACI")
#> Aciclovir
#> "https://atcddd.fhi.no/atc_ddd_index/?code=J05AB01&showdescription=no"
# lowercase transformation
av_name(x = c("ACI", "VALA"))
#> [1] "Aciclovir" "Valaciclovir"
av_name(x = c("ACI", "VALA"), tolower = TRUE)
#> [1] "aciclovir" "valaciclovir"
# defined daily doses (DDD)
av_ddd("ACI", "oral")
#> [1] 4
av_ddd_units("ACI", "oral")
#> [1] "g"
av_ddd("ACI", "iv")
#> [1] 4
av_ddd_units("ACI", "iv")
#> [1] "g"
av_info("ACI") # all properties as a list
#> $av
#> [1] "ACI"
#>
#> $cid
#> [1] 135398513
#>
#> $name
#> [1] "Aciclovir"
#>
#> $group
#> [1] "Nucleosides and nucleotides excl. reverse transcriptase inhibitors"
#>
#> $atc
#> [1] "J05AB01"
#>
#> $tradenames
#> [1] "acicloftal" "aciclovier" "aciclovirum"
#> [4] "activir" "acyclofoam" "acycloguanosine"
#> [7] "acyclovir" "acyclovir lauriad" "avaclyr"
#> [10] "cargosil" "cyclovir" "genvir"
#> [13] "gerpevir" "hascovir" "maynar"
#> [16] "novirus" "poviral" "sitavig"
#> [19] "sitavir" "vipral" "viropump"
#> [22] "virorax" "zovirax" "zyclir"
#>
#> $loinc
#> [1] ""
#>
#> $ddd
#> $ddd$oral
#> $ddd$oral$amount
#> [1] 4
#>
#> $ddd$oral$units
#> [1] "g"
#>
#>
#> $ddd$iv
#> $ddd$iv$amount
#> [1] 4
#>
#> $ddd$iv$units
#> [1] "g"
#>
#>
#>
# all av_* functions use as.av() internally, so you can go from 'any' to 'any':
av_atc("ACI")
#> [1] "J05AB01"
av_group("J05AB01")
#> [1] "Nucleosides and nucleotides excl. reverse transcriptase inhibitors"
av_loinc("abacavir")
#> [1] "29113-8" "30273-7" "30287-7" "30303-2" "78772-1" "78773-9" "79134-3"
#> [8] "80118-3"
av_name("29113-8")
#> [1] "Abacavir"
av_name(135398513)
#> [1] "Aciclovir"
av_name("J05AB01")
#> [1] "Aciclovir"
```