AMR/docs/reference/count.html

465 lines
27 KiB
HTML
Raw Normal View History

2018-12-23 21:26:21 +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">
<title>Count available isolates — count • AMR (for R)</title>
2018-12-29 22:24:19 +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" />
2019-10-13 09:31:58 +02:00
2018-12-23 21:26:21 +01: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>
2018-12-23 21:26:21 +01:00
<!-- Bootstrap -->
2020-04-13 21:09:56 +02:00
<link href="https://cdnjs.cloudflare.com/ajax/libs/bootswatch/3.4.0/flatly/bootstrap.min.css" rel="stylesheet" crossorigin="anonymous" />
2018-12-23 21:26:21 +01:00
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>
2018-12-23 21:26:21 +01:00
2020-04-17 19:16:30 +02:00
<!-- bootstrap-toc -->
<link rel="stylesheet" href="../bootstrap-toc.css">
<script src="../bootstrap-toc.js"></script>
2018-12-23 21:26:21 +01: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" />
2018-12-23 21:26:21 +01: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>
2018-12-23 21:26:21 +01: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>
2018-12-23 21:26:21 +01:00
<!-- pkgdown -->
<link href="../pkgdown.css" rel="stylesheet">
<script src="../pkgdown.js"></script>
2018-12-29 22:24:19 +01:00
<link href="../extra.css" rel="stylesheet">
<script src="../extra.js"></script>
2018-12-23 21:26:21 +01:00
<meta property="og:title" content="Count available isolates — count" />
2020-05-16 20:08:21 +02:00
<meta property="og:description" content="These functions can be used to count resistant/susceptible microbial isolates. All functions support quasiquotation with pipes, can be used in summarise() from the dplyr package and also support grouped variables, please see Examples.
2019-11-10 15:50:18 +01:00
count_resistant() should be used to count resistant isolates, count_susceptible() should be used to count susceptible isolates." />
<meta property="og:image" content="https://msberends.github.io/AMR/logo.png" />
2018-12-23 21:26:21 +01:00
2019-10-13 09:31:58 +02:00
2018-12-23 21:26:21 +01: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>
<!--[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
2018-12-23 21:26:21 +01:00
</head>
2020-04-17 19:16:30 +02:00
<body data-spy="scroll" data-target="#toc">
2018-12-23 21:26:21 +01: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">
2018-12-29 22:24:19 +01:00
<a class="navbar-link" href="../index.html">AMR (for R)</a>
<span class="version label label-default" data-toggle="tooltip" data-placement="bottom" title="Latest development version">1.3.0.9022</span>
2018-12-23 21:26:21 +01:00
</span>
</div>
<div id="navbar" class="navbar-collapse collapse">
<ul class="nav navbar-nav">
<li>
<a href="../index.html">
2018-12-29 22:24:19 +01:00
<span class="fa fa-home"></span>
2018-12-23 21:26:21 +01:00
2018-12-29 22:24:19 +01:00
Home
2018-12-23 21:26:21 +01:00
</a>
</li>
2019-01-02 23:24:07 +01:00
<li class="dropdown">
<a href="#" class="dropdown-toggle" data-toggle="dropdown" role="button" aria-expanded="false">
<span class="fa fa-question-circle"></span>
How to
2018-12-29 22:24:19 +01:00
2019-01-02 23:24:07 +01:00
<span class="caret"></span>
2018-12-29 22:24:19 +01:00
</a>
2019-01-02 23:24:07 +01:00
<ul class="dropdown-menu" role="menu">
<li>
<a href="../articles/AMR.html">
<span class="fa fa-directions"></span>
Conduct AMR analysis
</a>
</li>
<li>
2019-02-14 10:23:51 +01:00
<a href="../articles/resistance_predict.html">
2019-01-02 23:24:07 +01:00
<span class="fa fa-dice"></span>
Predict antimicrobial resistance
</a>
</li>
2020-08-21 11:40:13 +02:00
<li>
<a href="../articles/datasets.html">
<span class="fa fa-database"></span>
Data sets for download / own use
2020-08-21 11:40:13 +02:00
</a>
</li>
2020-04-13 21:09:56 +02:00
<li>
<a href="../articles/PCA.html">
<span class="fa fa-compress"></span>
Conduct principal component analysis for AMR
</a>
</li>
2019-05-23 16:58:59 +02:00
<li>
<a href="../articles/MDR.html">
<span class="fa fa-skull-crossbones"></span>
Determine multi-drug resistance (MDR)
</a>
</li>
2019-01-29 00:06:50 +01:00
<li>
<a href="../articles/WHONET.html">
<span class="fa fa-globe-americas"></span>
Work with WHONET data
</a>
</li>
2019-02-14 15:18:17 +01:00
<li>
<a href="../articles/SPSS.html">
<span class="fa fa-file-upload"></span>
Import data from SPSS/SAS/Stata
</a>
</li>
2019-01-02 23:24:07 +01:00
<li>
<a href="../articles/EUCAST.html">
<span class="fa fa-exchange-alt"></span>
Apply EUCAST rules
</a>
</li>
<li>
2019-02-14 10:23:51 +01:00
<a href="../reference/mo_property.html">
2019-01-02 23:24:07 +01:00
<span class="fa fa-bug"></span>
Get properties of a microorganism
</a>
</li>
<li>
2019-05-10 16:44:59 +02:00
<a href="../reference/ab_property.html">
2019-01-02 23:24:07 +01:00
<span class="fa fa-capsules"></span>
Get properties of an antibiotic
</a>
</li>
2019-01-11 20:37:23 +01:00
<li>
<a href="../articles/benchmarks.html">
<span class="fa fa-shipping-fast"></span>
Other: benchmarks
</a>
</li>
2019-01-02 23:24:07 +01:00
</ul>
2018-12-23 21:26:21 +01:00
</li>
<li>
2020-07-28 18:39:57 +02:00
<a href="../reference/index.html">
2018-12-29 22:24:19 +01:00
<span class="fa fa-book-open"></span>
Manual
</a>
2018-12-23 21:26:21 +01:00
</li>
2018-12-29 22:24:19 +01:00
<li>
<a href="../authors.html">
<span class="fa fa-users"></span>
2018-12-23 21:26:21 +01:00
2018-12-29 22:24:19 +01:00
Authors
2018-12-23 21:26:21 +01:00
</a>
</li>
<li>
2020-07-28 18:39:57 +02:00
<a href="../news/index.html">
2018-12-29 22:24:19 +01:00
<span class="far fa far fa-newspaper"></span>
Changelog
</a>
</li>
2019-01-02 23:24:07 +01:00
</ul>
<ul class="nav navbar-nav navbar-right">
<li>
2020-07-08 14:48:06 +02:00
<a href="https://github.com/msberends/AMR">
<span class="fab fa fab fa-github"></span>
2018-12-29 22:24:19 +01:00
Source Code
</a>
2018-12-23 21:26:21 +01:00
</li>
2019-01-02 23:24:07 +01:00
<li>
2020-07-28 18:39:57 +02:00
<a href="../survey.html">
<span class="fa fa-clipboard-list"></span>
2018-12-29 22:24:19 +01:00
2020-07-28 18:39:57 +02:00
Survey
2018-12-29 22:24:19 +01:00
</a>
</li>
2018-12-23 21:26:21 +01:00
</ul>
</div><!--/.nav-collapse -->
</div><!--/.container -->
</div><!--/.navbar -->
2019-10-13 09:31:58 +02:00
2018-12-23 21:26:21 +01:00
</header>
<div class="row">
<div class="col-md-9 contents">
<div class="page-header">
<h1>Count available isolates</h1>
2020-07-08 14:48:06 +02:00
<small class="dont-index">Source: <a href='https://github.com/msberends/AMR/blob/master/R/count.R'><code>R/count.R</code></a></small>
2018-12-23 21:26:21 +01:00
<div class="hidden name"><code>count.Rd</code></div>
</div>
<div class="ref-description">
2020-08-21 11:40:13 +02:00
<p>These functions can be used to count resistant/susceptible microbial isolates. All functions support quasiquotation with pipes, can be used in <code><a href='https://dplyr.tidyverse.org/reference/summarise.html'>summarise()</a></code> from the <code>dplyr</code> package and also support grouped variables, please see <em>Examples</em>.</p>
<p><code>count_resistant()</code> should be used to count resistant isolates, <code>count_susceptible()</code> should be used to count susceptible isolates.</p>
2018-12-23 21:26:21 +01:00
</div>
2020-08-10 12:46:03 +02:00
<pre class="usage"><span class='fu'>count_resistant</span>(<span class='kw'>...</span>, only_all_tested = <span class='fl'>FALSE</span>)
2020-08-10 12:46:03 +02:00
<span class='fu'>count_susceptible</span>(<span class='kw'>...</span>, only_all_tested = <span class='fl'>FALSE</span>)
2020-08-10 12:46:03 +02:00
<span class='fu'>count_R</span>(<span class='kw'>...</span>, only_all_tested = <span class='fl'>FALSE</span>)
2018-12-23 21:26:21 +01:00
2020-08-10 12:46:03 +02:00
<span class='fu'>count_IR</span>(<span class='kw'>...</span>, only_all_tested = <span class='fl'>FALSE</span>)
2018-12-23 21:26:21 +01:00
2020-08-10 12:46:03 +02:00
<span class='fu'>count_I</span>(<span class='kw'>...</span>, only_all_tested = <span class='fl'>FALSE</span>)
2018-12-23 21:26:21 +01:00
2020-08-10 12:46:03 +02:00
<span class='fu'>count_SI</span>(<span class='kw'>...</span>, only_all_tested = <span class='fl'>FALSE</span>)
2018-12-23 21:26:21 +01:00
2020-08-10 12:46:03 +02:00
<span class='fu'>count_S</span>(<span class='kw'>...</span>, only_all_tested = <span class='fl'>FALSE</span>)
2018-12-23 21:26:21 +01:00
2020-08-10 12:46:03 +02:00
<span class='fu'>count_all</span>(<span class='kw'>...</span>, only_all_tested = <span class='fl'>FALSE</span>)
2018-12-23 21:26:21 +01:00
2020-08-10 12:46:03 +02:00
<span class='fu'>n_rsi</span>(<span class='kw'>...</span>, only_all_tested = <span class='fl'>FALSE</span>)
2018-12-23 21:26:21 +01:00
<span class='fu'>count_df</span>(
2020-08-10 12:46:03 +02:00
<span class='kw'>data</span>,
translate_ab = <span class='st'>"name"</span>,
language = <span class='fu'><a href='translate.html'>get_locale</a></span>(),
combine_SI = <span class='fl'>TRUE</span>,
combine_IR = <span class='fl'>FALSE</span>
)</pre>
2019-10-13 09:31:58 +02:00
2018-12-23 21:26:21 +01: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>...</th>
<td><p>one or more vectors (or columns) with antibiotic interpretations. They will be transformed internally with <code><a href='as.rsi.html'>as.rsi()</a></code> if needed.</p></td>
2018-12-23 21:26:21 +01:00
</tr>
<tr>
<th>only_all_tested</th>
<td><p>(for combination therapies, i.e. using more than one variable for <code>...</code>): a logical to indicate that isolates must be tested for all antibiotics, see section <em>Combination therapy</em> below</p></td>
2018-12-23 21:26:21 +01:00
</tr>
<tr>
<th>data</th>
<td><p>a <a href='https://rdrr.io/r/base/data.frame.html'>data.frame</a> containing columns with class <code><a href='as.rsi.html'>rsi</a></code> (see <code><a href='as.rsi.html'>as.rsi()</a></code>)</p></td>
2018-12-23 21:26:21 +01:00
</tr>
<tr>
<th>translate_ab</th>
2020-06-25 17:34:50 +02:00
<td><p>a column name of the <a href='antibiotics.html'>antibiotics</a> data set to translate the antibiotic abbreviations to, using <code><a href='ab_property.html'>ab_property()</a></code>. Use a value</p></td>
2019-05-10 16:44:59 +02:00
</tr>
<tr>
<th>language</th>
<td><p>language of the returned text, defaults to system language (see <code><a href='translate.html'>get_locale()</a></code>) and can also be set with <code><a href='https://rdrr.io/r/base/options.html'>getOption("AMR_locale")</a></code>. Use <code>language = NULL</code> or <code>language = ""</code> to prevent translation.</p></td>
2018-12-23 21:26:21 +01:00
</tr>
<tr>
2019-05-13 10:10:16 +02:00
<th>combine_SI</th>
2019-05-23 16:58:59 +02:00
<td><p>a logical to indicate whether all values of S and I must be merged into one, so the output only consists of S+I vs. R (susceptible vs. resistant). This used to be the parameter <code>combine_IR</code>, but this now follows the redefinition by EUCAST about the interpretion of I (increased exposure) in 2019, see section 'Interpretation of S, I and R' below. Default is <code>TRUE</code>.</p></td>
2019-05-13 12:21:57 +02:00
</tr>
<tr>
<th>combine_IR</th>
<td><p>a logical to indicate whether all values of I and R must be merged into one, so the output only consists of S vs. I+R (susceptible vs. non-susceptible). This is outdated, see parameter <code>combine_SI</code>.</p></td>
2018-12-23 21:26:21 +01:00
</tr>
</table>
2019-10-13 09:31:58 +02:00
2018-12-23 21:26:21 +01: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></p>
2018-12-23 21:26:21 +01:00
<h2 class="hasAnchor" id="details"><a class="anchor" href="#details"></a>Details</h2>
<p>These functions are meant to count isolates. Use the <code><a href='proportion.html'>resistance()</a></code>/<code><a href='proportion.html'>susceptibility()</a></code> functions to calculate microbial resistance/susceptibility.</p>
2019-11-10 15:50:18 +01:00
<p>The function <code>count_resistant()</code> is equal to the function <code>count_R()</code>. The function <code>count_susceptible()</code> is equal to the function <code>count_SI()</code>.</p>
<p>The function <code>n_rsi()</code> is an alias of <code>count_all()</code>. They can be used to count all available isolates, i.e. where all input antibiotics have an available result (S, I or R). Their use is equal to <code><a href='https://dplyr.tidyverse.org/reference/n_distinct.html'>n_distinct()</a></code>. Their function is equal to <code>count_susceptible(...) + count_resistant(...)</code>.</p>
2020-05-16 13:05:47 +02:00
<p>The function <code>count_df()</code> takes any variable from <code>data</code> that has an <code><a href='as.rsi.html'>rsi</a></code> class (created with <code><a href='as.rsi.html'>as.rsi()</a></code>) and counts the number of S's, I's and R's. It also supports grouped variables. The function <code><a href='proportion.html'>rsi_df()</a></code> works exactly like <code>count_df()</code>, but adds the percentage of S, I and R.</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>
<p>If the unlying code needs breaking changes, they will occur gradually. For example, a parameter 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-11-29 19:43:23 +01:00
<h2 class="hasAnchor" id="interpretation-of-r-and-s-i"><a class="anchor" href="#interpretation-of-r-and-s-i"></a>Interpretation of R and S/I</h2>
2019-05-13 10:10:16 +02:00
2019-10-13 09:31:58 +02:00
<p>In 2019, the European Committee on Antimicrobial Susceptibility Testing (EUCAST) has decided to change the definitions of susceptibility testing categories R and S/I as shown below (<a href='http://www.eucast.org/newsiandr/'>http://www.eucast.org/newsiandr/</a>).</p><ul>
2019-11-29 19:43:23 +01:00
<li><p><strong>R = Resistant</strong><br />
A microorganism is categorised as <em>Resistant</em> when there is a high likelihood of therapeutic failure even when there is increased exposure. Exposure is a function of how the mode of administration, dose, dosing interval, infusion time, as well as distribution and excretion of the antimicrobial agent will influence the infecting organism at the site of infection.</p></li>
<li><p><strong>S = Susceptible</strong><br />
A microorganism is categorised as <em>Susceptible, standard dosing regimen</em>, when there is a high likelihood of therapeutic success using a standard dosing regimen of the agent.</p></li>
<li><p><strong>I = Increased exposure, but still susceptible</strong><br />
A microorganism is categorised as <em>Susceptible, Increased exposure</em> when there is a high likelihood of therapeutic success because exposure to the agent is increased by adjusting the dosing regimen or by its concentration at the site of infection.</p></li>
2019-05-13 10:10:16 +02:00
</ul>
2019-10-13 09:31:58 +02:00
<p>This AMR package honours this new insight. Use <code><a href='proportion.html'>susceptibility()</a></code> (equal to <code><a href='proportion.html'>proportion_SI()</a></code>) to determine antimicrobial susceptibility and <code>count_susceptible()</code> (equal to <code>count_SI()</code>) to count susceptible isolates.</p>
<h2 class="hasAnchor" id="combination-therapy"><a class="anchor" href="#combination-therapy"></a>Combination therapy</h2>
2019-10-13 09:31:58 +02:00
<p>When using more than one variable for <code>...</code> (= combination therapy), use <code>only_all_tested</code> to only count isolates that are tested for all antibiotics/variables that you test them for. See this example for two antibiotics, Drug A and Drug B, about how <code><a href='proportion.html'>susceptibility()</a></code> works to calculate the %SI:</p><pre>--------------------------------------------------------------------
only_all_tested = FALSE only_all_tested = TRUE
----------------------- -----------------------
Drug A Drug B include as include as include as include as
numerator denominator numerator denominator
-------- -------- ---------- ----------- ---------- -----------
S or I S or I X X X X
R S or I X X X X
2020-08-10 12:46:03 +02:00
&lt;NA&gt; S or I X X - -
S or I R X X X X
R R - X - X
2020-08-10 12:46:03 +02:00
&lt;NA&gt; R - - - -
S or I &lt;NA&gt; X X - -
R &lt;NA&gt; - - - -
&lt;NA&gt; &lt;NA&gt; - - - -
--------------------------------------------------------------------
</pre>
2019-10-13 09:31:58 +02:00
2020-08-10 12:46:03 +02:00
<p>Please note that, in combination therapies, for <code>only_all_tested = TRUE</code> applies that:</p><pre> <span class='fu'>count_S</span>() <span class='op'>+</span> <span class='fu'>count_I</span>() <span class='op'>+</span> <span class='fu'>count_R</span>() <span class='op'>=</span> <span class='fu'>count_all</span>()
<span class='fu'><a href='proportion.html'>proportion_S</a></span>() <span class='op'>+</span> <span class='fu'><a href='proportion.html'>proportion_I</a></span>() <span class='op'>+</span> <span class='fu'><a href='proportion.html'>proportion_R</a></span>() <span class='op'>=</span> <span class='fl'>1</span>
</pre>
2020-08-10 12:46:03 +02:00
<p>and that, in combination therapies, for <code>only_all_tested = FALSE</code> applies that:</p><pre> <span class='fu'>count_S</span>() <span class='op'>+</span> <span class='fu'>count_I</span>() <span class='op'>+</span> <span class='fu'>count_R</span>() <span class='op'>&gt;=</span> <span class='fu'>count_all</span>()
<span class='fu'><a href='proportion.html'>proportion_S</a></span>() <span class='op'>+</span> <span class='fu'><a href='proportion.html'>proportion_I</a></span>() <span class='op'>+</span> <span class='fu'><a href='proportion.html'>proportion_R</a></span>() <span class='op'>&gt;=</span> <span class='fl'>1</span>
</pre>
2019-10-13 09:31:58 +02:00
<p>Using <code>only_all_tested</code> has no impact when only using one antibiotic as input.</p>
2019-01-02 23:24:07 +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>
2019-10-13 09:31:58 +02:00
2020-07-28 18:39:57 +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> (which reads a lot easier than here in R) 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>
2018-12-23 21:26:21 +01: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='proportion.html'>proportion_*</a></code> to calculate microbial resistance and susceptibility.</p></div>
2018-12-23 21:26:21 +01:00
<h2 class="hasAnchor" id="examples"><a class="anchor" href="#examples"></a>Examples</h2>
2019-10-13 09:31:58 +02:00
<pre class="examples"><span class='co'># example_isolates is a data set available in the AMR package.</span>
2020-08-10 12:46:03 +02:00
<span class='op'>?</span><span class='kw'>example_isolates</span>
2019-01-02 23:24:07 +01:00
2020-08-10 12:46:03 +02:00
<span class='fu'>count_resistant</span>(<span class='kw'>example_isolates</span><span class='op'>$</span><span class='kw'>AMX</span>) <span class='co'># counts "R"</span>
<span class='fu'>count_susceptible</span>(<span class='kw'>example_isolates</span><span class='op'>$</span><span class='kw'>AMX</span>) <span class='co'># counts "S" and "I"</span>
<span class='fu'>count_all</span>(<span class='kw'>example_isolates</span><span class='op'>$</span><span class='kw'>AMX</span>) <span class='co'># counts "S", "I" and "R"</span>
2019-01-02 23:24:07 +01:00
<span class='co'># be more specific</span>
2020-08-10 12:46:03 +02:00
<span class='fu'>count_S</span>(<span class='kw'>example_isolates</span><span class='op'>$</span><span class='kw'>AMX</span>)
<span class='fu'>count_SI</span>(<span class='kw'>example_isolates</span><span class='op'>$</span><span class='kw'>AMX</span>)
<span class='fu'>count_I</span>(<span class='kw'>example_isolates</span><span class='op'>$</span><span class='kw'>AMX</span>)
<span class='fu'>count_IR</span>(<span class='kw'>example_isolates</span><span class='op'>$</span><span class='kw'>AMX</span>)
<span class='fu'>count_R</span>(<span class='kw'>example_isolates</span><span class='op'>$</span><span class='kw'>AMX</span>)
2019-01-02 23:24:07 +01:00
2018-12-23 21:26:21 +01:00
<span class='co'># Count all available isolates</span>
2020-08-10 12:46:03 +02:00
<span class='fu'>count_all</span>(<span class='kw'>example_isolates</span><span class='op'>$</span><span class='kw'>AMX</span>)
<span class='fu'>n_rsi</span>(<span class='kw'>example_isolates</span><span class='op'>$</span><span class='kw'>AMX</span>)
2019-01-02 23:24:07 +01:00
<span class='co'># n_rsi() is an alias of count_all().</span>
<span class='co'># Since it counts all available isolates, you can</span>
<span class='co'># calculate back to count e.g. susceptible isolates.</span>
<span class='co'># These results are the same:</span>
2020-08-10 12:46:03 +02:00
<span class='fu'>count_susceptible</span>(<span class='kw'>example_isolates</span><span class='op'>$</span><span class='kw'>AMX</span>)
<span class='fu'><a href='proportion.html'>susceptibility</a></span>(<span class='kw'>example_isolates</span><span class='op'>$</span><span class='kw'>AMX</span>) <span class='op'>*</span> <span class='fu'>n_rsi</span>(<span class='kw'>example_isolates</span><span class='op'>$</span><span class='kw'>AMX</span>)
<span class='co'>if</span> (<span class='fu'><a href='https://rdrr.io/r/base/library.html'>require</a></span>(<span class='st'><a href='https://dplyr.tidyverse.org'>"dplyr"</a></span>)) {
<span class='kw'>example_isolates</span> <span class='op'>%&gt;%</span>
<span class='fu'><a href='https://dplyr.tidyverse.org/reference/group_by.html'>group_by</a></span>(<span class='kw'>hospital_id</span>) <span class='op'>%&gt;%</span>
<span class='fu'><a href='https://dplyr.tidyverse.org/reference/summarise.html'>summarise</a></span>(R = <span class='fu'>count_R</span>(<span class='kw'>CIP</span>),
I = <span class='fu'>count_I</span>(<span class='kw'>CIP</span>),
S = <span class='fu'>count_S</span>(<span class='kw'>CIP</span>),
n1 = <span class='fu'>count_all</span>(<span class='kw'>CIP</span>), <span class='co'># the actual total; sum of all three</span>
n2 = <span class='fu'>n_rsi</span>(<span class='kw'>CIP</span>), <span class='co'># same - analogous to n_distinct</span>
total = <span class='fu'><a href='https://dplyr.tidyverse.org/reference/context.html'>n</a></span>()) <span class='co'># NOT the number of tested isolates!</span>
2020-05-16 20:08:21 +02:00
<span class='co'># Count co-resistance between amoxicillin/clav acid and gentamicin,</span>
<span class='co'># so we can see that combination therapy does a lot more than mono therapy.</span>
<span class='co'># Please mind that `susceptibility()` calculates percentages right away instead.</span>
2020-08-10 12:46:03 +02:00
<span class='kw'>example_isolates</span> <span class='op'>%&gt;%</span> <span class='fu'>count_susceptible</span>(<span class='kw'>AMC</span>) <span class='co'># 1433</span>
<span class='kw'>example_isolates</span> <span class='op'>%&gt;%</span> <span class='fu'>count_all</span>(<span class='kw'>AMC</span>) <span class='co'># 1879</span>
<span class='kw'>example_isolates</span> <span class='op'>%&gt;%</span> <span class='fu'>count_susceptible</span>(<span class='kw'>GEN</span>) <span class='co'># 1399</span>
<span class='kw'>example_isolates</span> <span class='op'>%&gt;%</span> <span class='fu'>count_all</span>(<span class='kw'>GEN</span>) <span class='co'># 1855</span>
<span class='kw'>example_isolates</span> <span class='op'>%&gt;%</span> <span class='fu'>count_susceptible</span>(<span class='kw'>AMC</span>, <span class='kw'>GEN</span>) <span class='co'># 1764</span>
<span class='kw'>example_isolates</span> <span class='op'>%&gt;%</span> <span class='fu'>count_all</span>(<span class='kw'>AMC</span>, <span class='kw'>GEN</span>) <span class='co'># 1936</span>
2020-05-16 20:08:21 +02:00
<span class='co'># Get number of S+I vs. R immediately of selected columns</span>
2020-08-10 12:46:03 +02:00
<span class='kw'>example_isolates</span> <span class='op'>%&gt;%</span>
<span class='fu'><a href='https://dplyr.tidyverse.org/reference/select.html'>select</a></span>(<span class='kw'>AMX</span>, <span class='kw'>CIP</span>) <span class='op'>%&gt;%</span>
<span class='fu'>count_df</span>(translate = <span class='fl'>FALSE</span>)
2020-05-16 20:08:21 +02:00
<span class='co'># It also supports grouping variables</span>
2020-08-10 12:46:03 +02:00
<span class='kw'>example_isolates</span> <span class='op'>%&gt;%</span>
<span class='fu'><a href='https://dplyr.tidyverse.org/reference/select.html'>select</a></span>(<span class='kw'>hospital_id</span>, <span class='kw'>AMX</span>, <span class='kw'>CIP</span>) <span class='op'>%&gt;%</span>
<span class='fu'><a href='https://dplyr.tidyverse.org/reference/group_by.html'>group_by</a></span>(<span class='kw'>hospital_id</span>) <span class='op'>%&gt;%</span>
<span class='fu'>count_df</span>(translate = <span class='fl'>FALSE</span>)
}
</pre>
2018-12-23 21:26:21 +01: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>
2018-12-23 21:26:21 +01:00
</div>
</div>
2019-10-13 09:31:58 +02:00
2018-12-23 21:26:21 +01:00
<footer>
<div class="copyright">
2020-02-17 14:38:01 +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>
2018-12-23 21:26:21 +01:00
</div>
<div class="pkgdown">
2020-08-10 12:46:03 +02:00
<p>Site built with <a href="https://pkgdown.r-lib.org/">pkgdown</a> 1.5.1.9000.</p>
2018-12-23 21:26:21 +01:00
</div>
2019-10-13 09:31:58 +02:00
2018-12-23 21:26:21 +01:00
</footer>
</div>
2019-10-13 09:31:58 +02:00
2018-12-23 21:26:21 +01:00
</body>
</html>
2019-10-13 09:31:58 +02:00