mirror of
https://github.com/msberends/AMR.git
synced 2024-12-25 07:26:12 +01:00
168 lines
16 KiB
HTML
168 lines
16 KiB
HTML
<!DOCTYPE html>
|
|
<!-- Generated by pkgdown: do not edit by hand --><html lang="en"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><meta charset="utf-8"><meta http-equiv="X-UA-Compatible" content="IE=edge"><meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no"><title>Get ATC Properties from WHOCC Website — atc_online_property • AMR (for R)</title><!-- favicons --><link rel="icon" type="image/png" sizes="16x16" href="../favicon-16x16.png"><link rel="icon" type="image/png" sizes="32x32" href="../favicon-32x32.png"><link rel="apple-touch-icon" type="image/png" sizes="180x180" href="../apple-touch-icon.png"><link rel="apple-touch-icon" type="image/png" sizes="120x120" href="../apple-touch-icon-120x120.png"><link rel="apple-touch-icon" type="image/png" sizes="76x76" href="../apple-touch-icon-76x76.png"><link rel="apple-touch-icon" type="image/png" sizes="60x60" href="../apple-touch-icon-60x60.png"><script src="../deps/jquery-3.6.0/jquery-3.6.0.min.js"></script><meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no"><link href="../deps/bootstrap-5.3.1/bootstrap.min.css" rel="stylesheet"><script src="../deps/bootstrap-5.3.1/bootstrap.bundle.min.js"></script><link href="../deps/Lato-0.4.9/font.css" rel="stylesheet"><link href="../deps/Fira_Code-0.4.9/font.css" rel="stylesheet"><link href="../deps/font-awesome-6.5.2/css/all.min.css" rel="stylesheet"><link href="../deps/font-awesome-6.5.2/css/v4-shims.min.css" rel="stylesheet"><script src="../deps/headroom-0.11.0/headroom.min.js"></script><script src="../deps/headroom-0.11.0/jQuery.headroom.min.js"></script><script src="../deps/bootstrap-toc-1.0.1/bootstrap-toc.min.js"></script><script src="../deps/clipboard.js-2.0.11/clipboard.min.js"></script><script src="../deps/search-1.0.0/autocomplete.jquery.min.js"></script><script src="../deps/search-1.0.0/fuse.min.js"></script><script src="../deps/search-1.0.0/mark.min.js"></script><!-- pkgdown --><script src="../pkgdown.js"></script><link href="../extra.css" rel="stylesheet"><script src="../extra.js"></script><meta property="og:title" content="Get ATC Properties from WHOCC Website — atc_online_property"><meta name="description" content="Gets data from the WHOCC website to determine properties of an Anatomical Therapeutic Chemical (ATC) (e.g. an antibiotic), such as the name, defined daily dose (DDD) or standard unit."><meta property="og:description" content="Gets data from the WHOCC website to determine properties of an Anatomical Therapeutic Chemical (ATC) (e.g. an antibiotic), such as the name, defined daily dose (DDD) or standard unit."><meta property="og:image" content="https://msberends.github.io/AMR/logo.svg"></head><body>
|
|
<a href="#main" class="visually-hidden-focusable">Skip to contents</a>
|
|
|
|
|
|
<nav class="navbar navbar-expand-lg fixed-top bg-primary" data-bs-theme="dark" aria-label="Site navigation"><div class="container">
|
|
|
|
<a class="navbar-brand me-2" href="../index.html">AMR (for R)</a>
|
|
|
|
<small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="">2.1.1.9122</small>
|
|
|
|
|
|
<button class="navbar-toggler" type="button" data-bs-toggle="collapse" data-bs-target="#navbar" aria-controls="navbar" aria-expanded="false" aria-label="Toggle navigation">
|
|
<span class="navbar-toggler-icon"></span>
|
|
</button>
|
|
|
|
<div id="navbar" class="collapse navbar-collapse ms-3">
|
|
<ul class="navbar-nav me-auto"><li class="nav-item dropdown">
|
|
<button class="nav-link dropdown-toggle" type="button" id="dropdown-how-to" data-bs-toggle="dropdown" aria-expanded="false" aria-haspopup="true"><span class="fa fa-question-circle"></span> How to</button>
|
|
<ul class="dropdown-menu" aria-labelledby="dropdown-how-to"><li><a class="dropdown-item" href="../articles/AMR.html"><span class="fa fa-directions"></span> Conduct AMR Analysis</a></li>
|
|
<li><a class="dropdown-item" href="../reference/antibiogram.html"><span class="fa fa-file-prescription"></span> Generate Antibiogram (Trad./Syndromic/WISCA)</a></li>
|
|
<li><a class="dropdown-item" href="../articles/resistance_predict.html"><span class="fa fa-dice"></span> Predict Antimicrobial Resistance</a></li>
|
|
<li><a class="dropdown-item" href="../articles/datasets.html"><span class="fa fa-database"></span> Download Data Sets for Own Use</a></li>
|
|
<li><a class="dropdown-item" href="../articles/AMR_with_tidymodels.html"><span class="fa fa-square-root-variable"></span> Use AMR for Predictive Modelling (tidymodels)</a></li>
|
|
<li><a class="dropdown-item" href="../reference/AMR-options.html"><span class="fa fa-gear"></span> Set User- Or Team-specific Package Settings</a></li>
|
|
<li><a class="dropdown-item" href="../articles/PCA.html"><span class="fa fa-compress"></span> Conduct Principal Component Analysis for AMR</a></li>
|
|
<li><a class="dropdown-item" href="../articles/MDR.html"><span class="fa fa-skull-crossbones"></span> Determine Multi-Drug Resistance (MDR)</a></li>
|
|
<li><a class="dropdown-item" href="../articles/WHONET.html"><span class="fa fa-globe-americas"></span> Work with WHONET Data</a></li>
|
|
<li><a class="dropdown-item" href="../articles/EUCAST.html"><span class="fa fa-exchange-alt"></span> Apply Eucast Rules</a></li>
|
|
<li><a class="dropdown-item" href="../reference/mo_property.html"><span class="fa fa-bug"></span> Get Taxonomy of a Microorganism</a></li>
|
|
<li><a class="dropdown-item" href="../reference/ab_property.html"><span class="fa fa-capsules"></span> Get Properties of an Antibiotic Drug</a></li>
|
|
<li><a class="dropdown-item" href="../reference/av_property.html"><span class="fa fa-capsules"></span> Get Properties of an Antiviral Drug</a></li>
|
|
</ul></li>
|
|
<li class="nav-item"><a class="nav-link" href="../articles/AMR_for_Python.html"><span class="fa fab fa-python"></span> AMR for Python</a></li>
|
|
<li class="active nav-item"><a class="nav-link" href="../reference/index.html"><span class="fa fa-book-open"></span> Manual</a></li>
|
|
<li class="nav-item"><a class="nav-link" href="../authors.html"><span class="fa fa-users"></span> Authors</a></li>
|
|
</ul><ul class="navbar-nav"><li class="nav-item"><a class="nav-link" href="../news/index.html"><span class="fa far fa-newspaper"></span> Changelog</a></li>
|
|
<li class="nav-item"><a class="external-link nav-link" href="https://github.com/msberends/AMR"><span class="fa fab fa-github"></span> Source Code</a></li>
|
|
</ul></div>
|
|
|
|
|
|
</div>
|
|
</nav><div class="container template-reference-topic">
|
|
<div class="row">
|
|
<main id="main" class="col-md-9"><div class="page-header">
|
|
<img src="../logo.svg" class="logo" alt=""><h1>Get ATC Properties from WHOCC Website</h1>
|
|
<small class="dont-index">Source: <a href="https://github.com/msberends/AMR/blob/main/R/atc_online.R" class="external-link"><code>R/atc_online.R</code></a></small>
|
|
<div class="d-none name"><code>atc_online.Rd</code></div>
|
|
</div>
|
|
|
|
<div class="ref-description section level2">
|
|
<p>Gets data from the WHOCC website to determine properties of an Anatomical Therapeutic Chemical (ATC) (e.g. an antibiotic), such as the name, defined daily dose (DDD) or standard unit.</p>
|
|
</div>
|
|
|
|
<div class="section level2">
|
|
<h2 id="ref-usage">Usage<a class="anchor" aria-label="anchor" href="#ref-usage"></a></h2>
|
|
<div class="sourceCode"><pre class="sourceCode r"><code><span><span class="fu">atc_online_property</span><span class="op">(</span></span>
|
|
<span> <span class="va">atc_code</span>,</span>
|
|
<span> <span class="va">property</span>,</span>
|
|
<span> administration <span class="op">=</span> <span class="st">"O"</span>,</span>
|
|
<span> url <span class="op">=</span> <span class="st">"https://atcddd.fhi.no/atc_ddd_index/?code=%s&showdescription=no"</span>,</span>
|
|
<span> url_vet <span class="op">=</span> <span class="st">"https://atcddd.fhi.no/atcvet/atcvet_index/?code=%s&showdescription=no"</span></span>
|
|
<span><span class="op">)</span></span>
|
|
<span></span>
|
|
<span><span class="fu">atc_online_groups</span><span class="op">(</span><span class="va">atc_code</span>, <span class="va">...</span><span class="op">)</span></span>
|
|
<span></span>
|
|
<span><span class="fu">atc_online_ddd</span><span class="op">(</span><span class="va">atc_code</span>, <span class="va">...</span><span class="op">)</span></span>
|
|
<span></span>
|
|
<span><span class="fu">atc_online_ddd_units</span><span class="op">(</span><span class="va">atc_code</span>, <span class="va">...</span><span class="op">)</span></span></code></pre></div>
|
|
</div>
|
|
|
|
<div class="section level2">
|
|
<h2 id="source">Source<a class="anchor" aria-label="anchor" href="#source"></a></h2>
|
|
<p><a href="https://atcddd.fhi.no/atc_ddd_alterations__cumulative/ddd_alterations/abbrevations/" class="external-link">https://atcddd.fhi.no/atc_ddd_alterations__cumulative/ddd_alterations/abbrevations/</a></p>
|
|
</div>
|
|
<div class="section level2">
|
|
<h2 id="arguments">Arguments<a class="anchor" aria-label="anchor" href="#arguments"></a></h2>
|
|
|
|
|
|
<dl><dt id="arg-atc-code">atc_code<a class="anchor" aria-label="anchor" href="#arg-atc-code"></a></dt>
|
|
<dd><p>a <a href="https://rdrr.io/r/base/character.html" class="external-link">character</a> (vector) with ATC code(s) of antibiotics, will be coerced with <code><a href="as.ab.html">as.ab()</a></code> and <code><a href="ab_property.html">ab_atc()</a></code> internally if not a valid ATC code</p></dd>
|
|
|
|
|
|
<dt id="arg-property">property<a class="anchor" aria-label="anchor" href="#arg-property"></a></dt>
|
|
<dd><p>property of an ATC code. Valid values are <code>"ATC"</code>, <code>"Name"</code>, <code>"DDD"</code>, <code>"U"</code> (<code>"unit"</code>), <code>"Adm.R"</code>, <code>"Note"</code> and <code>groups</code>. For this last option, all hierarchical groups of an ATC code will be returned, see <em>Examples</em>.</p></dd>
|
|
|
|
|
|
<dt id="arg-administration">administration<a class="anchor" aria-label="anchor" href="#arg-administration"></a></dt>
|
|
<dd><p>type of administration when using <code>property = "Adm.R"</code>, see <em>Details</em></p></dd>
|
|
|
|
|
|
<dt id="arg-url">url<a class="anchor" aria-label="anchor" href="#arg-url"></a></dt>
|
|
<dd><p>url of website of the WHOCC. The sign <code>%s</code> can be used as a placeholder for ATC codes.</p></dd>
|
|
|
|
|
|
<dt id="arg-url-vet">url_vet<a class="anchor" aria-label="anchor" href="#arg-url-vet"></a></dt>
|
|
<dd><p>url of website of the WHOCC for veterinary medicine. The sign <code>%s</code> can be used as a placeholder for ATC_vet codes (that all start with "Q").</p></dd>
|
|
|
|
|
|
<dt id="arg--">...<a class="anchor" aria-label="anchor" href="#arg--"></a></dt>
|
|
<dd><p>arguments to pass on to <code>atc_property</code></p></dd>
|
|
|
|
</dl></div>
|
|
<div class="section level2">
|
|
<h2 id="details">Details<a class="anchor" aria-label="anchor" href="#details"></a></h2>
|
|
<p>Options for argument <code>administration</code>:</p><ul><li><p><code>"Implant"</code> = Implant</p></li>
|
|
<li><p><code>"Inhal"</code> = Inhalation</p></li>
|
|
<li><p><code>"Instill"</code> = Instillation</p></li>
|
|
<li><p><code>"N"</code> = nasal</p></li>
|
|
<li><p><code>"O"</code> = oral</p></li>
|
|
<li><p><code>"P"</code> = parenteral</p></li>
|
|
<li><p><code>"R"</code> = rectal</p></li>
|
|
<li><p><code>"SL"</code> = sublingual/buccal</p></li>
|
|
<li><p><code>"TD"</code> = transdermal</p></li>
|
|
<li><p><code>"V"</code> = vaginal</p></li>
|
|
</ul><p>Abbreviations of return values when using <code>property = "U"</code> (unit):</p><ul><li><p><code>"g"</code> = gram</p></li>
|
|
<li><p><code>"mg"</code> = milligram</p></li>
|
|
<li><p><code>"mcg"</code> = microgram</p></li>
|
|
<li><p><code>"U"</code> = unit</p></li>
|
|
<li><p><code>"TU"</code> = thousand units</p></li>
|
|
<li><p><code>"MU"</code> = million units</p></li>
|
|
<li><p><code>"mmol"</code> = millimole</p></li>
|
|
<li><p><code>"ml"</code> = millilitre (e.g. eyedrops)</p></li>
|
|
</ul><p><strong>N.B. This function requires an internet connection and only works if the following packages are installed: <code>curl</code>, <code>rvest</code>, <code>xml2</code>.</strong></p>
|
|
</div>
|
|
|
|
<div class="section level2">
|
|
<h2 id="ref-examples">Examples<a class="anchor" aria-label="anchor" href="#ref-examples"></a></h2>
|
|
<div class="sourceCode"><pre class="sourceCode r"><code><span class="r-in"><span><span class="co"># \donttest{</span></span></span>
|
|
<span class="r-in"><span><span class="kw">if</span> <span class="op">(</span><span class="fu"><a href="https://rdrr.io/r/base/ns-load.html" class="external-link">requireNamespace</a></span><span class="op">(</span><span class="st">"curl"</span><span class="op">)</span> <span class="op">&&</span> <span class="fu"><a href="https://rdrr.io/r/base/ns-load.html" class="external-link">requireNamespace</a></span><span class="op">(</span><span class="st">"rvest"</span><span class="op">)</span> <span class="op">&&</span> <span class="fu"><a href="https://rdrr.io/r/base/ns-load.html" class="external-link">requireNamespace</a></span><span class="op">(</span><span class="st">"xml2"</span><span class="op">)</span><span class="op">)</span> <span class="op">{</span></span></span>
|
|
<span class="r-in"><span> <span class="co"># oral DDD (Defined Daily Dose) of amoxicillin</span></span></span>
|
|
<span class="r-in"><span> <span class="fu">atc_online_property</span><span class="op">(</span><span class="st">"J01CA04"</span>, <span class="st">"DDD"</span>, <span class="st">"O"</span><span class="op">)</span></span></span>
|
|
<span class="r-in"><span> <span class="fu">atc_online_ddd</span><span class="op">(</span><span class="fu"><a href="ab_property.html">ab_atc</a></span><span class="op">(</span><span class="st">"amox"</span><span class="op">)</span><span class="op">)</span></span></span>
|
|
<span class="r-in"><span></span></span>
|
|
<span class="r-in"><span> <span class="co"># parenteral DDD (Defined Daily Dose) of amoxicillin</span></span></span>
|
|
<span class="r-in"><span> <span class="fu">atc_online_property</span><span class="op">(</span><span class="st">"J01CA04"</span>, <span class="st">"DDD"</span>, <span class="st">"P"</span><span class="op">)</span></span></span>
|
|
<span class="r-in"><span></span></span>
|
|
<span class="r-in"><span> <span class="fu">atc_online_property</span><span class="op">(</span><span class="st">"J01CA04"</span>, property <span class="op">=</span> <span class="st">"groups"</span><span class="op">)</span> <span class="co"># search hierarchical groups of amoxicillin</span></span></span>
|
|
<span class="r-in"><span><span class="op">}</span></span></span>
|
|
<span class="r-msg co"><span class="r-pr">#></span> Loading required namespace: rvest</span>
|
|
<span class="r-out co"><span class="r-pr">#></span> [1] "ANTIINFECTIVES FOR SYSTEMIC USE" </span>
|
|
<span class="r-out co"><span class="r-pr">#></span> [2] "ANTIBACTERIALS FOR SYSTEMIC USE" </span>
|
|
<span class="r-out co"><span class="r-pr">#></span> [3] "BETA-LACTAM ANTIBACTERIALS, PENICILLINS"</span>
|
|
<span class="r-out co"><span class="r-pr">#></span> [4] "Penicillins with extended spectrum" </span>
|
|
<span class="r-in"><span><span class="co"># }</span></span></span>
|
|
</code></pre></div>
|
|
</div>
|
|
</main><aside class="col-md-3"><nav id="toc" aria-label="Table of contents"><h2>On this page</h2>
|
|
</nav></aside></div>
|
|
|
|
|
|
<footer><div class="pkgdown-footer-left">
|
|
<p><code>AMR</code> (for R). Free and open-source, licenced under the <a target="_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 <a target="_blank" href="https://www.rug.nl" class="external-link">University of Groningen</a> and <a target="_blank" href="https://www.umcg.nl" class="external-link">University Medical Center Groningen</a> in The Netherlands.</p>
|
|
</div>
|
|
|
|
<div class="pkgdown-footer-right">
|
|
<p><a target="_blank" href="https://www.rug.nl" class="external-link"><img src="https://github.com/msberends/AMR/raw/main/pkgdown/assets/logo_rug.svg" style="max-width: 150px;"></a><a target="_blank" href="https://www.umcg.nl" class="external-link"><img src="https://github.com/msberends/AMR/raw/main/pkgdown/assets/logo_umcg.svg" style="max-width: 150px;"></a></p>
|
|
</div>
|
|
|
|
</footer></div>
|
|
|
|
|
|
|
|
|
|
|
|
</body></html>
|
|
|