1
0
mirror of https://github.com/msberends/AMR.git synced 2024-12-27 08:06:13 +01:00
AMR/reference/as.disk.html

178 lines
18 KiB
HTML
Raw Normal View History

2022-08-21 16:59:35 +02:00
<!DOCTYPE html>
2024-09-19 14:48:19 +02:00
<!-- 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>Transform Input to Disk Diffusion Diameters — as.disk • 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.4.2/css/all.min.css" rel="stylesheet"><link href="../deps/font-awesome-6.4.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="Transform Input to Disk Diffusion Diameters — as.disk"><meta name="description" content="This transforms a vector to a new class disk, which is a disk diffusion growth zone size (around an antibiotic disk) in millimetres between 6 and 50."><meta property="og:description" content="This transforms a vector to a new class disk, which is a disk diffusion growth zone size (around an antibiotic disk) in millimetres between 6 and 50."><meta property="og:image" content="https://msberends.github.io/AMR/logo.svg"></head><body>
2022-08-21 16:59:35 +02:00
<a href="#main" class="visually-hidden-focusable">Skip to contents</a>
2024-07-16 15:00:55 +02:00
<nav class="navbar navbar-expand-lg fixed-top bg-primary" data-bs-theme="dark" aria-label="Site navigation"><div class="container">
2022-08-21 16:59:35 +02:00
<a class="navbar-brand me-2" href="../index.html">AMR (for R)</a>
2024-10-02 10:29:15 +02:00
<small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="">2.1.1.9086</small>
2024-07-16 15:00:55 +02:00
2022-08-21 16:59:35 +02:00
<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">
2023-05-24 16:03:18 +02:00
<ul class="navbar-nav me-auto"><li class="nav-item dropdown">
2024-07-16 15:00:55 +02:00
<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="../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>
2024-09-30 22:12:21 +02:00
<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>
2024-07-16 15:00:55 +02:00
<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>
2022-08-21 16:59:35 +02:00
</ul></div>
2024-07-16 15:00:55 +02:00
2022-08-21 16:59:35 +02:00
</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>Transform Input to Disk Diffusion Diameters</h1>
2024-07-16 15:00:55 +02:00
<small class="dont-index">Source: <a href="https://github.com/msberends/AMR/blob/main/R/disk.R" class="external-link"><code>R/disk.R</code></a></small>
2022-08-21 16:59:35 +02:00
<div class="d-none name"><code>as.disk.Rd</code></div>
</div>
<div class="ref-description section level2">
<p>This transforms a vector to a new class <code>disk</code>, which is a disk diffusion growth zone size (around an antibiotic disk) in millimetres between 6 and 50.</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">as.disk</span><span class="op">(</span><span class="va">x</span>, na.rm <span class="op">=</span> <span class="cn">FALSE</span><span class="op">)</span></span>
<span></span>
<span><span class="va">NA_disk_</span></span>
<span></span>
<span><span class="fu">is.disk</span><span class="op">(</span><span class="va">x</span><span class="op">)</span></span></code></pre></div>
</div>
<div class="section level2">
<h2 id="format">Format<a class="anchor" aria-label="anchor" href="#format"></a></h2>
<p>An object of class <code>disk</code> (inherits from <code>integer</code>) of length 1.</p>
</div>
<div class="section level2">
<h2 id="arguments">Arguments<a class="anchor" aria-label="anchor" href="#arguments"></a></h2>
2024-07-16 15:00:55 +02:00
<dl><dt id="arg-x">x<a class="anchor" aria-label="anchor" href="#arg-x"></a></dt>
2022-08-21 16:59:35 +02:00
<dd><p>vector</p></dd>
2024-07-16 15:00:55 +02:00
<dt id="arg-na-rm">na.rm<a class="anchor" aria-label="anchor" href="#arg-na-rm"></a></dt>
2022-08-21 16:59:35 +02:00
<dd><p>a <a href="https://rdrr.io/r/base/logical.html" class="external-link">logical</a> indicating whether missing values should be removed</p></dd>
</dl></div>
<div class="section level2">
<h2 id="value">Value<a class="anchor" aria-label="anchor" href="#value"></a></h2>
2024-07-16 15:00:55 +02:00
<p>An <a href="https://rdrr.io/r/base/integer.html" class="external-link">integer</a> with additional class <code>disk</code></p>
2022-08-21 16:59:35 +02:00
</div>
<div class="section level2">
<h2 id="details">Details<a class="anchor" aria-label="anchor" href="#details"></a></h2>
2023-01-21 23:53:21 +01:00
<p>Interpret disk values as SIR values with <code><a href="as.sir.html">as.sir()</a></code>. It supports guidelines from EUCAST and CLSI.</p>
2022-10-29 14:24:08 +02:00
<p>Disk diffusion growth zone sizes must be between 6 and 50 millimetres. Values higher than 50 but lower than 100 will be maximised to 50. All others input values outside the 6-50 range will return <code>NA</code>.</p>
2022-10-19 11:58:58 +02:00
<p><code>NA_disk_</code> is a missing value of the new <code>disk</code> class.</p>
2022-08-21 16:59:35 +02:00
</div>
<div class="section level2">
<h2 id="see-also">See also<a class="anchor" aria-label="anchor" href="#see-also"></a></h2>
2023-01-21 23:53:21 +01:00
<div class="dont-index"><p><code><a href="as.sir.html">as.sir()</a></code></p></div>
2022-08-21 16:59:35 +02:00
</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"># transform existing disk zones to the `disk` class (using base R)</span></span></span>
2022-08-28 22:45:38 +02:00
<span class="r-in"><span><span class="va">df</span> <span class="op">&lt;-</span> <span class="fu"><a href="https://rdrr.io/r/base/data.frame.html" class="external-link">data.frame</a></span><span class="op">(</span></span></span>
<span class="r-in"><span> microorganism <span class="op">=</span> <span class="st">"Escherichia coli"</span>,</span></span>
<span class="r-in"><span> AMP <span class="op">=</span> <span class="fl">20</span>,</span></span>
<span class="r-in"><span> CIP <span class="op">=</span> <span class="fl">14</span>,</span></span>
<span class="r-in"><span> GEN <span class="op">=</span> <span class="fl">18</span>,</span></span>
<span class="r-in"><span> TOB <span class="op">=</span> <span class="fl">16</span></span></span>
<span class="r-in"><span><span class="op">)</span></span></span>
2022-08-21 16:59:35 +02:00
<span class="r-in"><span><span class="va">df</span><span class="op">[</span>, <span class="fl">2</span><span class="op">:</span><span class="fl">5</span><span class="op">]</span> <span class="op">&lt;-</span> <span class="fu"><a href="https://rdrr.io/r/base/lapply.html" class="external-link">lapply</a></span><span class="op">(</span><span class="va">df</span><span class="op">[</span>, <span class="fl">2</span><span class="op">:</span><span class="fl">5</span><span class="op">]</span>, <span class="va">as.disk</span><span class="op">)</span></span></span>
<span class="r-in"><span><span class="fu"><a href="https://rdrr.io/r/utils/str.html" class="external-link">str</a></span><span class="op">(</span><span class="va">df</span><span class="op">)</span></span></span>
<span class="r-out co"><span class="r-pr">#&gt;</span> 'data.frame': 1 obs. of 5 variables:</span>
<span class="r-out co"><span class="r-pr">#&gt;</span> $ microorganism: chr "Escherichia coli"</span>
<span class="r-out co"><span class="r-pr">#&gt;</span> $ AMP : 'disk' int 20</span>
<span class="r-out co"><span class="r-pr">#&gt;</span> $ CIP : 'disk' int 14</span>
<span class="r-out co"><span class="r-pr">#&gt;</span> $ GEN : 'disk' int 18</span>
<span class="r-out co"><span class="r-pr">#&gt;</span> $ TOB : 'disk' int 16</span>
<span class="r-in"><span></span></span>
<span class="r-in"><span><span class="co"># \donttest{</span></span></span>
<span class="r-in"><span><span class="co"># transforming is easier with dplyr:</span></span></span>
<span class="r-in"><span><span class="kw">if</span> <span class="op">(</span><span class="kw"><a href="https://rdrr.io/r/base/library.html" class="external-link">require</a></span><span class="op">(</span><span class="st"><a href="https://dplyr.tidyverse.org" class="external-link">"dplyr"</a></span><span class="op">)</span><span class="op">)</span> <span class="op">{</span></span></span>
<span class="r-in"><span> <span class="va">df</span> <span class="op"><a href="https://magrittr.tidyverse.org/reference/pipe.html" class="external-link">%&gt;%</a></span> <span class="fu"><a href="https://dplyr.tidyverse.org/reference/mutate.html" class="external-link">mutate</a></span><span class="op">(</span><span class="fu"><a href="https://dplyr.tidyverse.org/reference/across.html" class="external-link">across</a></span><span class="op">(</span><span class="va">AMP</span><span class="op">:</span><span class="va">TOB</span>, <span class="va">as.disk</span><span class="op">)</span><span class="op">)</span></span></span>
<span class="r-in"><span><span class="op">}</span></span></span>
<span class="r-out co"><span class="r-pr">#&gt;</span> microorganism AMP CIP GEN TOB</span>
<span class="r-out co"><span class="r-pr">#&gt;</span> 1 Escherichia coli 20 14 18 16</span>
<span class="r-in"><span><span class="co"># }</span></span></span>
<span class="r-in"><span></span></span>
2023-01-21 23:53:21 +01:00
<span class="r-in"><span><span class="co"># interpret disk values, see ?as.sir</span></span></span>
<span class="r-in"><span><span class="fu"><a href="as.sir.html">as.sir</a></span><span class="op">(</span></span></span>
2022-08-28 22:45:38 +02:00
<span class="r-in"><span> x <span class="op">=</span> <span class="fu">as.disk</span><span class="op">(</span><span class="fl">18</span><span class="op">)</span>,</span></span>
<span class="r-in"><span> mo <span class="op">=</span> <span class="st">"Strep pneu"</span>, <span class="co"># `mo` will be coerced with as.mo()</span></span></span>
<span class="r-in"><span> ab <span class="op">=</span> <span class="st">"ampicillin"</span>, <span class="co"># and `ab` with as.ab()</span></span></span>
<span class="r-in"><span> guideline <span class="op">=</span> <span class="st">"EUCAST"</span></span></span>
<span class="r-in"><span><span class="op">)</span></span></span>
2024-09-19 14:05:20 +02:00
<span class="r-msg co"><span class="r-pr">#&gt;</span> </span>
2023-07-11 09:57:23 +02:00
<span class="r-msg co"><span class="r-pr">#&gt;</span> Run sir_interpretation_history() afterwards to retrieve a logbook with</span>
2024-06-17 10:46:35 +02:00
<span class="r-msg co"><span class="r-pr">#&gt;</span> all the details of the breakpoint interpretations.</span>
2024-06-14 22:48:53 +02:00
<span class="r-msg co"><span class="r-pr">#&gt;</span> Interpreting disk diffusion zones: 'ampicillin' (AMP), EUCAST 2024...</span>
2024-06-10 10:40:19 +02:00
<span class="r-msg co"><span class="r-pr">#&gt;</span> OK </span>
<span class="r-out co"><span class="r-pr">#&gt;</span> Class 'sir'</span>
2024-09-30 19:20:49 +02:00
<span class="r-out co"><span class="r-pr">#&gt;</span> [1] R</span>
2022-08-21 16:59:35 +02:00
<span class="r-in"><span></span></span>
<span class="r-in"><span><span class="co"># interpret whole data set, pretend to be all from urinary tract infections:</span></span></span>
2023-01-21 23:53:21 +01:00
<span class="r-in"><span><span class="fu"><a href="as.sir.html">as.sir</a></span><span class="op">(</span><span class="va">df</span>, uti <span class="op">=</span> <span class="cn">TRUE</span><span class="op">)</span></span></span>
2024-09-19 14:05:20 +02:00
<span class="r-msg co"><span class="r-pr">#&gt;</span> </span>
2023-07-11 09:57:23 +02:00
<span class="r-msg co"><span class="r-pr">#&gt;</span> Run sir_interpretation_history() afterwards to retrieve a logbook with</span>
2024-06-17 10:46:35 +02:00
<span class="r-msg co"><span class="r-pr">#&gt;</span> all the details of the breakpoint interpretations.</span>
2024-06-10 10:40:19 +02:00
<span class="r-msg co"><span class="r-pr">#&gt;</span> Interpreting disk diffusion zones: column 'AMP' (ampicillin), EUCAST</span>
2024-06-14 22:48:53 +02:00
<span class="r-msg co"><span class="r-pr">#&gt;</span> 2024...</span>
2024-06-10 10:40:19 +02:00
<span class="r-msg co"><span class="r-pr">#&gt;</span> OK </span>
<span class="r-msg co"><span class="r-pr">#&gt;</span> Interpreting disk diffusion zones: column 'CIP' (ciprofloxacin), EUCAST</span>
2024-06-14 22:48:53 +02:00
<span class="r-msg co"><span class="r-pr">#&gt;</span> 2024...</span>
2024-06-10 10:40:19 +02:00
<span class="r-msg co"><span class="r-pr">#&gt;</span> OK </span>
<span class="r-msg co"><span class="r-pr">#&gt;</span> Interpreting disk diffusion zones: column 'GEN' (gentamicin), EUCAST</span>
2024-06-14 22:48:53 +02:00
<span class="r-msg co"><span class="r-pr">#&gt;</span> 2024...</span>
2024-06-10 10:40:19 +02:00
<span class="r-msg co"><span class="r-pr">#&gt;</span> OK </span>
<span class="r-msg co"><span class="r-pr">#&gt;</span> Interpreting disk diffusion zones: column 'TOB' (tobramycin), EUCAST</span>
2024-06-14 22:48:53 +02:00
<span class="r-msg co"><span class="r-pr">#&gt;</span> 2024...</span>
2024-06-10 10:40:19 +02:00
<span class="r-msg co"><span class="r-pr">#&gt;</span> OK </span>
<span class="r-out co"><span class="r-pr">#&gt;</span> microorganism AMP CIP GEN TOB</span>
<span class="r-out co"><span class="r-pr">#&gt;</span> 1 Escherichia coli S &lt;NA&gt; S S</span>
2022-08-21 16:59:35 +02:00
</code></pre></div>
</div>
2024-07-16 15:00:55 +02:00
</main><aside class="col-md-3"><nav id="toc" aria-label="Table of contents"><h2>On this page</h2>
2022-08-21 16:59:35 +02:00
</nav></aside></div>
<footer><div class="pkgdown-footer-left">
2024-04-23 10:39:01 +02:00
<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>
2022-08-21 16:59:35 +02:00
</div>
<div class="pkgdown-footer-right">
2024-09-19 14:48:19 +02:00
<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>
2022-08-21 16:59:35 +02:00
</div>
</footer></div>
2024-07-16 15:00:55 +02:00
2022-08-21 16:59:35 +02:00
</body></html>