P281424/AMR
1
0
Fork 0
mirror of https://github.com/msberends/AMR.git synced 2024-12-26 19:26:12 +01:00
Code Releases Activity
2eca8c3f01
AMR/docs/reference/random.html

339 lines
15 KiB
HTML
Raw Normal View History

(v1.4.0.9037) random_* functions
2020-12-12 23:17:29 +01: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">
(v1.5.0.9006) major documentation update
2021-01-18 16:57:56 +01:00
<title>Random MIC Values/Disk Zones/RSI Generation — random • AMR (for R)</title>
(v1.4.0.9037) random_* functions
2020-12-12 23:17:29 +01: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" />
<!-- jquery -->
<script src="https://cdnjs.cloudflare.com/ajax/libs/jquery/3.4.1/jquery.min.js" integrity="sha256-CSXorXvZcTkaix6Yvo6HppcZGetbYMGWSFlBw8HfCJo=" crossorigin="anonymous"></script>
<!-- Bootstrap -->
(v1.4.0.9046) get_episode
2020-12-27 00:07:00 +01:00
<link href="https://cdnjs.cloudflare.com/ajax/libs/bootswatch/3.4.0/flatly/bootstrap.min.css" rel="stylesheet" crossorigin="anonymous" />
(v1.4.0.9037) random_* functions
2020-12-12 23:17:29 +01:00
(v1.4.0.9042) auto dark theme website
2020-12-21 22:46:29 +01:00
(v1.4.0.9044) mo tibble printing, mo_shortname() fix
2020-12-24 23:29:10 +01: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>
(v1.4.0.9042) auto dark theme website
2020-12-21 22:46:29 +01:00
(v1.4.0.9037) random_* functions
2020-12-12 23:17:29 +01:00
<!-- bootstrap-toc -->
<link rel="stylesheet" href="../bootstrap-toc.css">
<script src="../bootstrap-toc.js"></script>
<!-- Font Awesome icons -->
<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" />
<!-- clipboard.js -->
<script src="https://cdnjs.cloudflare.com/ajax/libs/clipboard.js/2.0.6/clipboard.min.js" integrity="sha256-inc5kl9MA1hkeYUt+EC3BhlIgyp/2jDIyBLS6k3UxPI=" crossorigin="anonymous"></script>
<!-- headroom.js -->
<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>
<!-- pkgdown -->
<link href="../pkgdown.css" rel="stylesheet">
<script src="../pkgdown.js"></script>
<link href="../extra.css" rel="stylesheet">
<script src="../extra.js"></script>
(v1.5.0.9006) major documentation update
2021-01-18 16:57:56 +01:00
<meta property="og:title" content="Random MIC Values/Disk Zones/RSI Generation — random" />
(v1.5.0.9014) only_rsi_columns, is.rsi.eligible improvement
2021-02-02 23:57:35 +01:00
<meta property="og:description" content="These functions can be used for generating random MIC values and disk diffusion diameters, for AMR data analysis practice." />
(v1.4.0.9037) random_* functions
2020-12-12 23:17:29 +01:00
<meta property="og:image" content="https://msberends.github.io/AMR/logo.png" />
<!-- 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>
<!--[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]-->
</head>
<body data-spy="scroll" data-target="#toc">
<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>
(v1.5.0.9014) only_rsi_columns, is.rsi.eligible improvement
2021-02-02 23:57:35 +01:00
<span class="version label label-default" data-toggle="tooltip" data-placement="bottom" title="Latest development version">1.5.0.9014</span>
(v1.4.0.9037) random_* functions
2020-12-12 23:17:29 +01:00
</span>
</div>
<div id="navbar" class="navbar-collapse collapse">
<ul class="nav navbar-nav">
<li>
<a href="../index.html">
(v1.4.0.9042) auto dark theme website
2020-12-21 22:46:29 +01:00
<span class="fas fa-home"></span>
(v1.4.0.9037) random_* functions
2020-12-12 23:17:29 +01:00
Home
</a>
</li>
<li class="dropdown">
<a href="#" class="dropdown-toggle" data-toggle="dropdown" role="button" aria-expanded="false">
(v1.4.0.9042) auto dark theme website
2020-12-21 22:46:29 +01:00
<span class="fas fa-question-circle"></span>
(v1.4.0.9037) random_* functions
2020-12-12 23:17:29 +01:00
How to
<span class="caret"></span>
</a>
<ul class="dropdown-menu" role="menu">
<li>
<a href="../articles/AMR.html">
(v1.4.0.9042) auto dark theme website
2020-12-21 22:46:29 +01:00
<span class="fas fa-directions"></span>
(v1.4.0.9037) random_* functions
2020-12-12 23:17:29 +01:00
Conduct AMR analysis
</a>
</li>
<li>
<a href="../articles/resistance_predict.html">
(v1.4.0.9042) auto dark theme website
2020-12-21 22:46:29 +01:00
<span class="fas fa-dice"></span>
(v1.4.0.9037) random_* functions
2020-12-12 23:17:29 +01:00
Predict antimicrobial resistance
</a>
</li>
<li>
<a href="../articles/datasets.html">
(v1.4.0.9042) auto dark theme website
2020-12-21 22:46:29 +01:00
<span class="fas fa-database"></span>
(v1.4.0.9037) random_* functions
2020-12-12 23:17:29 +01:00
Data sets for download / own use
</a>
</li>
<li>
<a href="../articles/PCA.html">
(v1.4.0.9042) auto dark theme website
2020-12-21 22:46:29 +01:00
<span class="fas fa-compress"></span>
(v1.4.0.9037) random_* functions
2020-12-12 23:17:29 +01:00
Conduct principal component analysis for AMR
</a>
</li>
<li>
<a href="../articles/MDR.html">
(v1.4.0.9042) auto dark theme website
2020-12-21 22:46:29 +01:00
<span class="fas fa-skull-crossbones"></span>
(v1.4.0.9037) random_* functions
2020-12-12 23:17:29 +01:00
Determine multi-drug resistance (MDR)
</a>
</li>
<li>
<a href="../articles/WHONET.html">
(v1.4.0.9042) auto dark theme website
2020-12-21 22:46:29 +01:00
<span class="fas fa-globe-americas"></span>
(v1.4.0.9037) random_* functions
2020-12-12 23:17:29 +01:00
Work with WHONET data
</a>
</li>
<li>
<a href="../articles/SPSS.html">
(v1.4.0.9042) auto dark theme website
2020-12-21 22:46:29 +01:00
<span class="fas fa-file-upload"></span>
(v1.4.0.9037) random_* functions
2020-12-12 23:17:29 +01:00
Import data from SPSS/SAS/Stata
</a>
</li>
<li>
<a href="../articles/EUCAST.html">
(v1.4.0.9042) auto dark theme website
2020-12-21 22:46:29 +01:00
<span class="fas fa-exchange-alt"></span>
(v1.4.0.9037) random_* functions
2020-12-12 23:17:29 +01:00
Apply EUCAST rules
</a>
</li>
<li>
<a href="../reference/mo_property.html">
(v1.4.0.9042) auto dark theme website
2020-12-21 22:46:29 +01:00
<span class="fas fa-bug"></span>
(v1.4.0.9037) random_* functions
2020-12-12 23:17:29 +01:00
Get properties of a microorganism
</a>
</li>
<li>
<a href="../reference/ab_property.html">
(v1.4.0.9042) auto dark theme website
2020-12-21 22:46:29 +01:00
<span class="fas fa-capsules"></span>
(v1.4.0.9037) random_* functions
2020-12-12 23:17:29 +01:00
Get properties of an antibiotic
</a>
</li>
<li>
<a href="../articles/benchmarks.html">
(v1.4.0.9042) auto dark theme website
2020-12-21 22:46:29 +01:00
<span class="fas fa-shipping-fast"></span>
(v1.4.0.9037) random_* functions
2020-12-12 23:17:29 +01:00
Other: benchmarks
</a>
</li>
</ul>
</li>
<li>
<a href="../reference/index.html">
(v1.4.0.9042) auto dark theme website
2020-12-21 22:46:29 +01:00
<span class="fas fa-book-open"></span>
(v1.4.0.9037) random_* functions
2020-12-12 23:17:29 +01:00
Manual
</a>
</li>
<li>
<a href="../authors.html">
(v1.4.0.9042) auto dark theme website
2020-12-21 22:46:29 +01:00
<span class="fas fa-users"></span>
(v1.4.0.9037) random_* functions
2020-12-12 23:17:29 +01:00
Authors
</a>
</li>
<li>
<a href="../news/index.html">
(v1.4.0.9042) auto dark theme website
2020-12-21 22:46:29 +01:00
<span class="far fa-newspaper"></span>
(v1.4.0.9037) random_* functions
2020-12-12 23:17:29 +01:00
Changelog
</a>
</li>
</ul>
<ul class="nav navbar-nav navbar-right">
<li>
<a href="https://github.com/msberends/AMR">
(v1.4.0.9042) auto dark theme website
2020-12-21 22:46:29 +01:00
<span class="fab fa-github"></span>
(v1.4.0.9037) random_* functions
2020-12-12 23:17:29 +01:00
Source Code
</a>
</li>
<li>
<a href="../survey.html">
(v1.4.0.9042) auto dark theme website
2020-12-21 22:46:29 +01:00
<span class="fas fa-clipboard-list"></span>
(v1.4.0.9037) random_* functions
2020-12-12 23:17:29 +01:00
Survey
</a>
</li>
</ul>
</div><!--/.nav-collapse -->
</div><!--/.container -->
</div><!--/.navbar -->
</header>
<div class="row">
<div class="col-md-9 contents">
<div class="page-header">
(v1.5.0.9006) major documentation update
2021-01-18 16:57:56 +01:00
<h1>Random MIC Values/Disk Zones/RSI Generation</h1>
(v1.4.0.9037) random_* functions
2020-12-12 23:17:29 +01:00
<small class="dont-index">Source: <a href='https://github.com/msberends/AMR/blob/master/R/random.R'><code>R/random.R</code></a></small>
<div class="hidden name"><code>random.Rd</code></div>
</div>
<div class="ref-description">
(v1.5.0.9014) only_rsi_columns, is.rsi.eligible improvement
2021-02-02 23:57:35 +01:00
<p>These functions can be used for generating random MIC values and disk diffusion diameters, for AMR data analysis practice.</p>
(v1.4.0.9037) random_* functions
2020-12-12 23:17:29 +01:00
</div>
<pre class="usage"><span class='fu'>random_mic</span><span class='op'>(</span><span class='va'>size</span>, mo <span class='op'>=</span> <span class='cn'>NULL</span>, ab <span class='op'>=</span> <span class='cn'>NULL</span>, <span class='va'>...</span><span class='op'>)</span>
<span class='fu'>random_disk</span><span class='op'>(</span><span class='va'>size</span>, mo <span class='op'>=</span> <span class='cn'>NULL</span>, ab <span class='op'>=</span> <span class='cn'>NULL</span>, <span class='va'>...</span><span class='op'>)</span>
<span class='fu'>random_rsi</span><span class='op'>(</span><span class='va'>size</span>, prob_RSI <span class='op'>=</span> <span class='fu'><a href='https://rdrr.io/r/base/c.html'>c</a></span><span class='op'>(</span><span class='fl'>0.33</span>, <span class='fl'>0.33</span>, <span class='fl'>0.33</span><span class='op'>)</span>, <span class='va'>...</span><span class='op'>)</span></pre>
<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>size</th>
<td><p>desired size of the returned vector</p></td>
</tr>
<tr>
<th>mo</th>
<td><p>any character that can be coerced to a valid microorganism code with <code><a href='as.mo.html'>as.mo()</a></code></p></td>
</tr>
<tr>
<th>ab</th>
<td><p>any character that can be coerced to a valid antimicrobial agent code with <code><a href='as.ab.html'>as.ab()</a></code></p></td>
</tr>
<tr>
<th>...</th>
<td><p>extension for future versions, not used at the moment</p></td>
</tr>
<tr>
<th>prob_RSI</th>
<td><p>a vector of length 3: the probabilities for R (1st value), S (2nd value) and I (3rd value)</p></td>
</tr>
</table>
<h2 class="hasAnchor" id="value"><a class="anchor" href="#value"></a>Value</h2>
<p>class <code>&lt;mic&gt;</code> for <code>random_mic()</code> (see <code><a href='as.mic.html'>as.mic()</a></code>) and class <code>&lt;disk&gt;</code> for <code>random_disk()</code> (see <code><a href='as.disk.html'>as.disk()</a></code>)</p>
<h2 class="hasAnchor" id="details"><a class="anchor" href="#details"></a>Details</h2>
<p>The base R function <code><a href='https://rdrr.io/r/base/sample.html'>sample()</a></code> is used for generating values.</p>
(v1.4.0.9043) documentation update
2020-12-22 00:51:17 +01:00
<p>Generated values are based on the latest EUCAST guideline implemented in the <a href='rsi_translation.html'>rsi_translation</a> data set. To create specific generated values per bug or drug, set the <code>mo</code> and/or <code>ab</code> argument.</p>
(v1.5.0.9006) major documentation update
2021-01-18 16:57:56 +01:00
<h2 class="hasAnchor" id="maturing-lifecycle"><a class="anchor" href="#maturing-lifecycle"></a>Maturing Lifecycle</h2>
(v1.4.0.9037) random_* functions
2020-12-12 23:17:29 +01:00
<p><img src='figures/lifecycle_maturing.svg' style=margin-bottom:5px /> <br />
The <a href='lifecycle.html'>lifecycle</a> of this function is <strong>maturing</strong>. The unlying code of a maturing function has been roughed out, but finer details might still change. Since this function needs wider usage and more extensive testing, you are very welcome <a href='https://github.com/msberends/AMR/issues'>to suggest changes at our repository</a> or <a href='AMR.html'>write us an email (see section 'Contact Us')</a>.</p>
(v1.5.0.9006) major documentation update
2021-01-18 16:57:56 +01: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>
(v1.4.0.9037) random_* functions
2020-12-12 23:17:29 +01:00
(v1.5.0.9014) only_rsi_columns, is.rsi.eligible improvement
2021-02-02 23:57:35 +01: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 data 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>
(v1.4.0.9037) random_* functions
2020-12-12 23:17:29 +01:00
<h2 class="hasAnchor" id="examples"><a class="anchor" href="#examples"></a>Examples</h2>
<pre class="examples"><span class='fu'>random_mic</span><span class='op'>(</span><span class='fl'>100</span><span class='op'>)</span>
<span class='fu'>random_disk</span><span class='op'>(</span><span class='fl'>100</span><span class='op'>)</span>
<span class='fu'>random_rsi</span><span class='op'>(</span><span class='fl'>100</span><span class='op'>)</span>
<span class='co'># \donttest{</span>
<span class='co'># make the random generation more realistic by setting a bug and/or drug:</span>
<span class='fu'>random_mic</span><span class='op'>(</span><span class='fl'>100</span>, <span class='st'>"Klebsiella pneumoniae"</span><span class='op'>)</span> <span class='co'># range 0.0625-64</span>
<span class='fu'>random_mic</span><span class='op'>(</span><span class='fl'>100</span>, <span class='st'>"Klebsiella pneumoniae"</span>, <span class='st'>"meropenem"</span><span class='op'>)</span> <span class='co'># range 0.0625-16</span>
<span class='fu'>random_mic</span><span class='op'>(</span><span class='fl'>100</span>, <span class='st'>"Streptococcus pneumoniae"</span>, <span class='st'>"meropenem"</span><span class='op'>)</span> <span class='co'># range 0.0625-4</span>
<span class='fu'>random_disk</span><span class='op'>(</span><span class='fl'>100</span>, <span class='st'>"Klebsiella pneumoniae"</span><span class='op'>)</span> <span class='co'># range 11-50</span>
<span class='fu'>random_disk</span><span class='op'>(</span><span class='fl'>100</span>, <span class='st'>"Klebsiella pneumoniae"</span>, <span class='st'>"ampicillin"</span><span class='op'>)</span> <span class='co'># range 6-14</span>
<span class='fu'>random_disk</span><span class='op'>(</span><span class='fl'>100</span>, <span class='st'>"Streptococcus pneumoniae"</span>, <span class='st'>"ampicillin"</span><span class='op'>)</span> <span class='co'># range 16-22</span>
<span class='co'># }</span>
</pre>
</div>
<div class="col-md-3 hidden-xs hidden-sm" id="pkgdown-sidebar">
<nav id="toc" data-toggle="toc" class="sticky-top">
<h2 data-toc-skip>Contents</h2>
</nav>
</div>
</div>
<footer>
<div class="copyright">
<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>
</div>
<div class="pkgdown">
(v1.4.0.9044) mo tibble printing, mo_shortname() fix
2020-12-24 23:29:10 +01:00
<p>Site built with <a href="https://pkgdown.r-lib.org/">pkgdown</a> 1.6.1.</p>
(v1.4.0.9037) random_* functions
2020-12-12 23:17:29 +01:00
</div>
</footer>
</div>
</body>
</html>
Copy Permalink