1
0
mirror of https://github.com/msberends/AMR.git synced 2024-12-26 19:26:12 +01:00
AMR/docs/reference/as.disk.html

364 lines
15 KiB
HTML
Raw Normal View History

2019-05-10 16:44:59 +02:00
<!-- Generated by pkgdown: do not edit by hand -->
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
2020-12-21 22:46:29 +01:00
<!-- Inform modern browsers that this page supports both dark and light color schemes,
and the page author prefers light. -->
<meta name="color-scheme" content="dark light">
<script>
// If `prefers-color-scheme` is not supported, fall back to light mode.
// i.e. In this case, inject the `light` CSS before the others, with
// no media filter so that it will be downloaded with highest priority.
if (window.matchMedia("(prefers-color-scheme: dark)").media === "not all") {
document.documentElement.style.display = "none";
document.head.insertAdjacentHTML(
"beforeend",
"<link id=\"css\" rel=\"stylesheet\" href=\"bootstrap.css\" onload=\"document.documentElement.style.display = ''\">"
);
}
</script>
<title>Transform input to disk diffusion diameters — as.disk • AMR (for R)</title>
2019-05-10 16:44:59 +02:00
<!-- 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" />
2019-10-13 09:31:58 +02:00
2019-05-10 16:44:59 +02:00
<!-- jquery -->
2020-04-13 21:09:56 +02:00
<script src="https://cdnjs.cloudflare.com/ajax/libs/jquery/3.4.1/jquery.min.js" integrity="sha256-CSXorXvZcTkaix6Yvo6HppcZGetbYMGWSFlBw8HfCJo=" crossorigin="anonymous"></script>
2019-05-10 16:44:59 +02:00
<!-- Bootstrap -->
2019-10-13 09:31:58 +02:00
2020-04-13 21:09:56 +02:00
<script src="https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/3.4.1/js/bootstrap.min.js" integrity="sha256-nuL8/2cJ5NDSSwnKD8VqreErSWHtnEP9E7AySL+1ev4=" crossorigin="anonymous"></script>
2019-05-10 16:44:59 +02:00
2020-12-21 22:46:29 +01:00
<!-- Flatly Theme - Light -->
<link id="css-light" rel="stylesheet" href="https://bootswatch.com/3/flatly/bootstrap.css" media="(prefers-color-scheme: light), (prefers-color-scheme: no-preference)">
<!-- Darkly Theme - Dark -->
<link id="css-dark" rel="stylesheet" href="https://bootswatch.com/3/darkly/bootstrap.css" media="(prefers-color-scheme: dark)">
<!-- preferably CSS -->
<link rel="stylesheet" href="../preferably.css">
<link id="css-code-light" rel="stylesheet" href="../code-color-scheme-light.css" media="(prefers-color-scheme: light), (prefers-color-scheme: no-preference)">
<link id="css-code-dark" rel="stylesheet" href="../code-color-scheme-dark.css" media="(prefers-color-scheme: dark)">
2020-04-17 19:16:30 +02:00
<!-- bootstrap-toc -->
<link rel="stylesheet" href="../bootstrap-toc.css">
<script src="../bootstrap-toc.js"></script>
2019-05-10 16:44:59 +02:00
<!-- Font Awesome icons -->
2020-04-17 19:16:30 +02:00
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.12.1/css/all.min.css" integrity="sha256-mmgLkCYLUQbXn0B1SRqzHar6dCnv9oZFPEC1g1cwlkk=" crossorigin="anonymous" />
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.12.1/css/v4-shims.min.css" integrity="sha256-wZjR52fzng1pJHwx4aV2AO3yyTOXrcDW7jBpJtTwVxw=" crossorigin="anonymous" />
2019-05-10 16:44:59 +02:00
<!-- clipboard.js -->
2020-04-17 19:16:30 +02:00
<script src="https://cdnjs.cloudflare.com/ajax/libs/clipboard.js/2.0.6/clipboard.min.js" integrity="sha256-inc5kl9MA1hkeYUt+EC3BhlIgyp/2jDIyBLS6k3UxPI=" crossorigin="anonymous"></script>
2019-05-10 16:44:59 +02:00
2019-10-13 09:31:58 +02:00
<!-- headroom.js -->
2020-04-17 19:16:30 +02:00
<script src="https://cdnjs.cloudflare.com/ajax/libs/headroom/0.11.0/headroom.min.js" integrity="sha256-AsUX4SJE1+yuDu5+mAVzJbuYNPHj/WroHuZ8Ir/CkE0=" crossorigin="anonymous"></script>
<script src="https://cdnjs.cloudflare.com/ajax/libs/headroom/0.11.0/jQuery.headroom.min.js" integrity="sha256-ZX/yNShbjqsohH1k95liqY9Gd8uOiE1S4vZc+9KQ1K4=" crossorigin="anonymous"></script>
2019-05-10 16:44:59 +02:00
<!-- pkgdown -->
<link href="../pkgdown.css" rel="stylesheet">
<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 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.png" />
2019-05-10 16:44:59 +02:00
2019-10-13 09:31:58 +02:00
2019-05-10 16:44:59 +02:00
<!-- mathjax -->
<script src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/MathJax.js" integrity="sha256-nvJJv9wWKEm88qvoQl9ekL2J+k/RWIsaSScxxlsrv8k=" crossorigin="anonymous"></script>
<script src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/config/TeX-AMS-MML_HTMLorMML.js" integrity="sha256-84DKXVJXs0/F8OTMzX4UR909+jtl4G7SPypPavF+GfA=" crossorigin="anonymous"></script>
2020-12-21 22:46:29 +01:00
2019-05-10 16:44:59 +02:00
<!--[if lt IE 9]>
<script src="https://oss.maxcdn.com/html5shiv/3.7.3/html5shiv.min.js"></script>
<script src="https://oss.maxcdn.com/respond/1.4.2/respond.min.js"></script>
<![endif]-->
2019-10-13 09:31:58 +02:00
2019-05-10 16:44:59 +02:00
</head>
2020-04-17 19:16:30 +02:00
<body data-spy="scroll" data-target="#toc">
2019-05-10 16:44:59 +02:00
<div class="container template-reference-topic">
<header>
<div class="navbar navbar-default navbar-fixed-top" role="navigation">
<div class="container">
<div class="navbar-header">
<button type="button" class="navbar-toggle collapsed" data-toggle="collapse" data-target="#navbar" aria-expanded="false">
<span class="sr-only">Toggle navigation</span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
<span class="navbar-brand">
<a class="navbar-link" href="../index.html">AMR (for R)</a>
2020-12-22 00:51:17 +01:00
<span class="version label label-default" data-toggle="tooltip" data-placement="bottom" title="Latest development version">1.4.0.9043</span>
2019-05-10 16:44:59 +02:00
</span>
</div>
<div id="navbar" class="navbar-collapse collapse">
<ul class="nav navbar-nav">
<li>
<a href="../index.html">
2020-12-21 22:46:29 +01:00
<span class="fas fa-home"></span>
2019-05-10 16:44:59 +02:00
Home
</a>
</li>
<li class="dropdown">
<a href="#" class="dropdown-toggle" data-toggle="dropdown" role="button" aria-expanded="false">
2020-12-21 22:46:29 +01:00
<span class="fas fa-question-circle"></span>
2019-05-10 16:44:59 +02:00
How to
<span class="caret"></span>
</a>
<ul class="dropdown-menu" role="menu">
<li>
<a href="../articles/AMR.html">
2020-12-21 22:46:29 +01:00
<span class="fas fa-directions"></span>
2019-05-10 16:44:59 +02:00
Conduct AMR analysis
</a>
</li>
<li>
<a href="../articles/resistance_predict.html">
2020-12-21 22:46:29 +01:00
<span class="fas fa-dice"></span>
2019-05-10 16:44:59 +02:00
Predict antimicrobial resistance
</a>
2020-08-21 11:40:13 +02:00
</li>
<li>
<a href="../articles/datasets.html">
2020-12-21 22:46:29 +01:00
<span class="fas fa-database"></span>
2020-08-21 11:40:13 +02:00
Data sets for download / own use
2020-08-21 11:40:13 +02:00
</a>
2019-05-10 16:44:59 +02:00
</li>
2020-04-13 21:09:56 +02:00
<li>
<a href="../articles/PCA.html">
2020-12-21 22:46:29 +01:00
<span class="fas fa-compress"></span>
2020-04-13 21:09:56 +02:00
Conduct principal component analysis for AMR
</a>
</li>
2019-05-28 16:50:40 +02:00
<li>
<a href="../articles/MDR.html">
2020-12-21 22:46:29 +01:00
<span class="fas fa-skull-crossbones"></span>
2019-05-28 16:50:40 +02:00
Determine multi-drug resistance (MDR)
</a>
</li>
2019-05-10 16:44:59 +02:00
<li>
<a href="../articles/WHONET.html">
2020-12-21 22:46:29 +01:00
<span class="fas fa-globe-americas"></span>
2019-05-10 16:44:59 +02:00
Work with WHONET data
</a>
</li>
<li>
<a href="../articles/SPSS.html">
2020-12-21 22:46:29 +01:00
<span class="fas fa-file-upload"></span>
2019-05-10 16:44:59 +02:00
Import data from SPSS/SAS/Stata
</a>
</li>
<li>
<a href="../articles/EUCAST.html">
2020-12-21 22:46:29 +01:00
<span class="fas fa-exchange-alt"></span>
2019-05-10 16:44:59 +02:00
Apply EUCAST rules
</a>
</li>
<li>
<a href="../reference/mo_property.html">
2020-12-21 22:46:29 +01:00
<span class="fas fa-bug"></span>
2019-05-10 16:44:59 +02:00
Get properties of a microorganism
</a>
</li>
<li>
<a href="../reference/ab_property.html">
2020-12-21 22:46:29 +01:00
<span class="fas fa-capsules"></span>
2019-05-10 16:44:59 +02:00
Get properties of an antibiotic
</a>
</li>
<li>
<a href="../articles/benchmarks.html">
2020-12-21 22:46:29 +01:00
<span class="fas fa-shipping-fast"></span>
2019-05-10 16:44:59 +02:00
Other: benchmarks
</a>
</li>
</ul>
</li>
<li>
2020-07-28 18:39:57 +02:00
<a href="../reference/index.html">
2020-12-21 22:46:29 +01:00
<span class="fas fa-book-open"></span>
2019-05-10 16:44:59 +02:00
Manual
</a>
</li>
<li>
<a href="../authors.html">
2020-12-21 22:46:29 +01:00
<span class="fas fa-users"></span>
2019-05-10 16:44:59 +02:00
Authors
</a>
</li>
<li>
2020-07-28 18:39:57 +02:00
<a href="../news/index.html">
2020-12-21 22:46:29 +01:00
<span class="far fa-newspaper"></span>
2019-05-10 16:44:59 +02:00
Changelog
</a>
</li>
</ul>
<ul class="nav navbar-nav navbar-right">
2020-12-21 22:46:29 +01:00
2019-05-10 16:44:59 +02:00
<li>
2020-07-08 14:48:06 +02:00
<a href="https://github.com/msberends/AMR">
2020-12-21 22:46:29 +01:00
<span class="fab fa-github"></span>
2019-05-10 16:44:59 +02:00
Source Code
</a>
</li>
<li>
2020-07-28 18:39:57 +02:00
<a href="../survey.html">
2020-12-21 22:46:29 +01:00
<span class="fas fa-clipboard-list"></span>
2019-05-10 16:44:59 +02:00
2020-07-28 18:39:57 +02:00
Survey
2019-05-10 16:44:59 +02:00
</a>
</li>
</ul>
</div><!--/.nav-collapse -->
</div><!--/.container -->
</div><!--/.navbar -->
2019-10-13 09:31:58 +02:00
2019-05-10 16:44:59 +02:00
</header>
<div class="row">
<div class="col-md-9 contents">
<div class="page-header">
<h1>Transform input to disk diffusion diameters</h1>
2020-07-08 14:48:06 +02:00
<small class="dont-index">Source: <a href='https://github.com/msberends/AMR/blob/master/R/disk.R'><code>R/disk.R</code></a></small>
2019-05-10 16:44:59 +02:00
<div class="hidden name"><code>as.disk.Rd</code></div>
</div>
<div class="ref-description">
<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>
2019-05-10 16:44:59 +02:00
</div>
<pre class="usage"><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>
2019-05-10 16:44:59 +02:00
<span class='fu'>is.disk</span><span class='op'>(</span><span class='va'>x</span><span class='op'>)</span></pre>
2019-10-13 09:31:58 +02:00
2019-05-10 16:44:59 +02:00
<h2 class="hasAnchor" id="arguments"><a class="anchor" href="#arguments"></a>Arguments</h2>
<table class="ref-arguments">
<colgroup><col class="name" /><col class="desc" /></colgroup>
<tr>
<th>x</th>
<td><p>vector</p></td>
</tr>
<tr>
<th>na.rm</th>
<td><p>a logical indicating whether missing values should be removed</p></td>
</tr>
</table>
2019-10-13 09:31:58 +02:00
2019-05-10 16:44:59 +02:00
<h2 class="hasAnchor" id="value"><a class="anchor" href="#value"></a>Value</h2>
<p>An <a href='https://rdrr.io/r/base/integer.html'>integer</a> with additional class <code>disk</code></p>
2019-05-10 16:44:59 +02:00
<h2 class="hasAnchor" id="details"><a class="anchor" href="#details"></a>Details</h2>
<p>Interpret disk values as RSI values with <code><a href='as.rsi.html'>as.rsi()</a></code>. It supports guidelines from EUCAST and CLSI.</p>
<h2 class="hasAnchor" id="stable-lifecycle"><a class="anchor" href="#stable-lifecycle"></a>Stable lifecycle</h2>
<p><img src='figures/lifecycle_stable.svg' style=margin-bottom:5px /> <br />
The <a href='lifecycle.html'>lifecycle</a> of this function is <strong>stable</strong>. In a stable function, major changes are unlikely. This means that the unlying code will generally evolve by adding new arguments; removing arguments or changing the meaning of existing arguments will be avoided.</p>
2020-12-22 00:51:17 +01:00
<p>If the unlying code needs breaking changes, they will occur gradually. For example, a argument will be deprecated and first continue to work, but will emit an message informing you of the change. Next, typically after at least one newly released version on CRAN, the message will be transformed to an error.</p>
2019-05-10 16:44:59 +02:00
<h2 class="hasAnchor" id="read-more-on-our-website-"><a class="anchor" href="#read-more-on-our-website-"></a>Read more on our website!</h2>
2019-10-13 09:31:58 +02:00
2020-10-08 11:16:03 +02:00
<p>On our website <a href='https://msberends.github.io/AMR/'>https://msberends.github.io/AMR/</a> you can find <a href='https://msberends.github.io/AMR/articles/AMR.html'>a comprehensive tutorial</a> about how to conduct AMR analysis, the <a href='https://msberends.github.io/AMR/reference/'>complete documentation of all functions</a> and <a href='https://msberends.github.io/AMR/articles/WHONET.html'>an example analysis using WHONET data</a>. As we would like to better understand the backgrounds and needs of our users, please <a href='https://msberends.github.io/AMR/survey.html'>participate in our survey</a>!</p>
2019-05-10 16:44:59 +02:00
<h2 class="hasAnchor" id="see-also"><a class="anchor" href="#see-also"></a>See also</h2>
<div class='dont-index'><p><code><a href='as.rsi.html'>as.rsi()</a></code></p></div>
2019-05-10 16:44:59 +02:00
<h2 class="hasAnchor" id="examples"><a class="anchor" href="#examples"></a>Examples</h2>
<pre class="examples"><span class='co'># \donttest{</span>
2020-05-16 21:40:50 +02:00
<span class='co'># transform existing disk zones to the `disk` class</span>
<span class='va'>df</span> <span class='op'>&lt;-</span> <span class='fu'><a href='https://rdrr.io/r/base/data.frame.html'>data.frame</a></span><span class='op'>(</span>microorganism <span class='op'>=</span> <span class='st'>"E. coli"</span>,
AMP <span class='op'>=</span> <span class='fl'>20</span>,
CIP <span class='op'>=</span> <span class='fl'>14</span>,
GEN <span class='op'>=</span> <span class='fl'>18</span>,
TOB <span class='op'>=</span> <span class='fl'>16</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='op'>&lt;-</span> <span class='fu'><a href='https://rdrr.io/r/base/lapply.html'>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 class='co'># same with dplyr:</span>
<span class='co'># df %&gt;% mutate(across(AMP:TOB, as.disk))</span>
2020-02-17 14:38:01 +01:00
<span class='co'># interpret disk values, see ?as.rsi</span>
<span class='fu'><a href='as.rsi.html'>as.rsi</a></span><span class='op'>(</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>,
mo <span class='op'>=</span> <span class='st'>"Strep pneu"</span>, <span class='co'># `mo` will be coerced with as.mo()</span>
ab <span class='op'>=</span> <span class='st'>"ampicillin"</span>, <span class='co'># and `ab` with as.ab()</span>
guideline <span class='op'>=</span> <span class='st'>"EUCAST"</span><span class='op'>)</span>
2020-08-10 12:46:03 +02:00
<span class='fu'><a href='as.rsi.html'>as.rsi</a></span><span class='op'>(</span><span class='va'>df</span><span class='op'>)</span>
<span class='co'># }</span>
</pre>
2019-05-10 16:44:59 +02:00
</div>
2020-04-13 21:09:56 +02:00
<div class="col-md-3 hidden-xs hidden-sm" id="pkgdown-sidebar">
2020-04-17 19:16:30 +02:00
<nav id="toc" data-toggle="toc" class="sticky-top">
<h2 data-toc-skip>Contents</h2>
</nav>
2019-05-10 16:44:59 +02:00
</div>
</div>
2019-10-13 09:31:58 +02:00
2019-05-10 16:44:59 +02:00
<footer>
<div class="copyright">
2020-01-26 20:38:54 +01:00
<p>Developed by <a href='https://www.rug.nl/staff/m.s.berends/'>Matthijs S. Berends</a>, <a href='https://www.rug.nl/staff/c.f.luz/'>Christian F. Luz</a>, <a href='https://www.rug.nl/staff/a.w.friedrich/'>Alexander W. Friedrich</a>, <a href='https://www.rug.nl/staff/b.sinha/'>Bhanu N. M. Sinha</a>, <a href='https://www.rug.nl/staff/c.j.albers/'>Casper J. Albers</a>, <a href='https://www.rug.nl/staff/c.glasner/'>Corinna Glasner</a>.</p>
2019-05-10 16:44:59 +02:00
</div>
<div class="pkgdown">
2020-12-21 22:46:29 +01:00
<p>Made with <a href="https://pkgdown.r-lib.org/">pkgdown</a> 1.6.1, using <a href="https://preferably.amirmasoudabdol.name/?source=footer">preferably</a> template.</p>
2019-05-10 16:44:59 +02:00
</div>
2019-10-13 09:31:58 +02:00
2019-05-10 16:44:59 +02:00
</footer>
</div>
2019-10-13 09:31:58 +02:00
2019-05-10 16:44:59 +02:00
</body>
</html>
2019-10-13 09:31:58 +02:00