<!-- Generated by pkgdown: do not edit by hand --><htmllang="en"><head><metahttp-equiv="Content-Type"content="text/html; charset=UTF-8"><metacharset="utf-8"><metahttp-equiv="X-UA-Compatible"content="IE=edge"><metaname="viewport"content="width=device-width, initial-scale=1, shrink-to-fit=no"><title>Get Properties of an Antiviral Drug — av_property • AMR (for R)</title><!-- favicons --><linkrel="icon"type="image/png"sizes="16x16"href="../favicon-16x16.png"><linkrel="icon"type="image/png"sizes="32x32"href="../favicon-32x32.png"><linkrel="apple-touch-icon"type="image/png"sizes="180x180"href="../apple-touch-icon.png"><linkrel="apple-touch-icon"type="image/png"sizes="120x120"href="../apple-touch-icon-120x120.png"><linkrel="apple-touch-icon"type="image/png"sizes="76x76"href="../apple-touch-icon-76x76.png"><linkrel="apple-touch-icon"type="image/png"sizes="60x60"href="../apple-touch-icon-60x60.png"><scriptsrc="../deps/jquery-3.6.0/jquery-3.6.0.min.js"></script><metaname="viewport"content="width=device-width, initial-scale=1, shrink-to-fit=no"><linkhref="../deps/bootstrap-5.3.1/bootstrap.min.css"rel="stylesheet"><scriptsrc="../deps/bootstrap-5.3.1/bootstrap.bundle.min.js"></script><linkhref="../deps/Lato-0.4.9/font.css"rel="stylesheet"><linkhref="../deps/Fira_Code-0.4.9/font.css"rel="stylesheet"><linkhref="../deps/font-awesome-6.5.2/css/all.min.css"rel="stylesheet"><linkhref="../deps/font-awesome-6.5.2/css/v4-shims.min.css"rel="stylesheet"><scriptsrc="../deps/headroom-0.11.0/headroom.min.js"></script><scriptsrc="../deps/headroom-0.11.0/jQuery.headroom.min.js"></script><scriptsrc="../deps/bootstrap-toc-1.0.1/bootstrap-toc.min.js"></script><scriptsrc="../deps/clipboard.js-2.0.11/clipboard.min.js"></script><scriptsrc="../deps/search-1.0.0/autocomplete.jquery.min.js"></script><scriptsrc="../deps/search-1.0.0/fuse.min.js"></script><scriptsrc="../deps/search-1.0.0/mark.min.js"></script><!-- pkgdown --><scriptsrc="../pkgdown.js"></script><linkhref="../extra.css"rel="stylesheet"><scriptsrc="../extra.js"></script><metaproperty="og:title"content="Get Properties of an Antiviral Drug — av_property"><metaname="description"content="Use these functions to return a specific property of an antiviral drug from the antivirals data set. All input values will be evaluated internally with as.av()."><metaproperty="og:description"content="Use these functions to return a specific property of an antiviral drug from the antivirals data set. All input values will be evaluated internally with as.av()."><metaproperty="og:image"content="https://msberends.github.io/AMR/logo.svg"></head><body>
<buttonclass="nav-link dropdown-toggle"type="button"id="dropdown-how-to"data-bs-toggle="dropdown"aria-expanded="false"aria-haspopup="true"><spanclass="fa fa-question-circle"></span> How to</button>
<ulclass="dropdown-menu"aria-labelledby="dropdown-how-to"><li><aclass="dropdown-item"href="../articles/AMR.html"><spanclass="fa fa-directions"></span> Conduct AMR Analysis</a></li>
<p>Use these functions to return a specific property of an antiviral drug from the <ahref="antibiotics.html">antivirals</a> data set. All input values will be evaluated internally with <code><ahref="as.av.html">as.av()</a></code>.</p>
<span><spanclass="fu">av_group</span><spanclass="op">(</span><spanclass="va">x</span>, language <spanclass="op">=</span><spanclass="fu"><ahref="translate.html">get_AMR_locale</a></span><spanclass="op">(</span><spanclass="op">)</span>, <spanclass="va">...</span><spanclass="op">)</span></span>
<span><spanclass="fu">av_info</span><spanclass="op">(</span><spanclass="va">x</span>, language <spanclass="op">=</span><spanclass="fu"><ahref="translate.html">get_AMR_locale</a></span><spanclass="op">(</span><spanclass="op">)</span>, <spanclass="va">...</span><spanclass="op">)</span></span>
<span></span>
<span><spanclass="fu">av_url</span><spanclass="op">(</span><spanclass="va">x</span>, open <spanclass="op">=</span><spanclass="cn">FALSE</span>, <spanclass="va">...</span><spanclass="op">)</span></span>
<span></span>
<span><spanclass="fu">av_property</span><spanclass="op">(</span><spanclass="va">x</span>, property <spanclass="op">=</span><spanclass="st">"name"</span>, language <spanclass="op">=</span><spanclass="fu"><ahref="translate.html">get_AMR_locale</a></span><spanclass="op">(</span><spanclass="op">)</span>, <spanclass="va">...</span><spanclass="op">)</span></span></code></pre></div>
<dd><p>language of the returned text - the default is system language (see <code><ahref="translate.html">get_AMR_locale()</a></code>) and can also be set with the package option <code><ahref="AMR-options.html">AMR_locale</a></code>. Use <code>language = NULL</code> or <code>language = ""</code> to prevent translation.</p></dd>
<dd><p>a <ahref="https://rdrr.io/r/base/logical.html"class="external-link">logical</a> to indicate whether the first <ahref="https://rdrr.io/r/base/character.html"class="external-link">character</a> of every output should be transformed to a lower case <ahref="https://rdrr.io/r/base/character.html"class="external-link">character</a>.</p></dd>
<dd><p>one of the column names of one of the <ahref="antibiotics.html">antivirals</a> data set: <code>vector_or(colnames(antivirals), sort = FALSE)</code>.</p></dd>
<ul><li><p>An <ahref="https://rdrr.io/r/base/integer.html"class="external-link">integer</a> in case of <code>av_cid()</code></p></li>
<li><p>A named <ahref="https://rdrr.io/r/base/list.html"class="external-link">list</a> in case of <code>av_info()</code> and multiple <code>av_atc()</code>/<code>av_synonyms()</code>/<code>av_tradenames()</code></p></li>
<li><p>A <ahref="https://rdrr.io/r/base/double.html"class="external-link">double</a> in case of <code>av_ddd()</code></p></li>
<li><p>A <ahref="https://rdrr.io/r/base/character.html"class="external-link">character</a> in all other cases</p></li>
<p>All output <ahref="translate.html">will be translated</a> where possible.</p>
<p>The function <code>av_url()</code> will return the direct URL to the official WHO website. A warning will be returned if the required ATC code is not available.</p>
<p>World Health Organization (WHO) Collaborating Centre for Drug Statistics Methodology: <ahref="https://atcddd.fhi.no/atc_ddd_index/"class="external-link">https://atcddd.fhi.no/atc_ddd_index/</a></p>
<p>European Commission Public Health PHARMACEUTICALS - COMMUNITY REGISTER: <ahref="https://ec.europa.eu/health/documents/community-register/html/reg_hum_atc.htm"class="external-link">https://ec.europa.eu/health/documents/community-register/html/reg_hum_atc.htm</a></p>
</div>
<divclass="section level2">
<h2id="reference-data-publicly-available">Reference Data Publicly Available<aclass="anchor"aria-label="anchor"href="#reference-data-publicly-available"></a></h2>
<p>All data sets in this <code>AMR</code> package (about microorganisms, antibiotics, SIR interpretation, EUCAST rules, etc.) are publicly and freely available for download in the following formats: R, MS Excel, Apache Feather, Apache Parquet, SPSS, 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 <ahref="https://msberends.github.io/AMR/articles/datasets.html">our website for the download links</a>. The actual files are of course available on <ahref="https://github.com/msberends/AMR/tree/main/data-raw"class="external-link">our GitHub repository</a>.</p>
<spanclass="r-in"><span><spanclass="fu">av_info</span><spanclass="op">(</span><spanclass="st">"ACI"</span><spanclass="op">)</span><spanclass="co"># all properties as a list</span></span></span>
<p><code>AMR</code> (for R). Free and open-source, licenced under the <atarget="_blank"href="https://github.com/msberends/AMR/blob/main/LICENSE"class="external-link">GNU General Public License version 2.0 (GPL-2)</a>.<br>Developed at the <atarget="_blank"href="https://www.rug.nl"class="external-link">University of Groningen</a> and <atarget="_blank"href="https://www.umcg.nl"class="external-link">University Medical Center Groningen</a> in The Netherlands.</p>
