AMR/docs/reference/eucast_rules.html

458 lines
53 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>Apply EUCAST Rules — eucast_rules • 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" />
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-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" />
2020-12-21 22:46:29 +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>
2020-12-21 22:46:29 +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
<!-- 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="Apply EUCAST Rules — eucast_rules" />
<meta property="og:description" content="Apply rules for clinical breakpoints and intrinsic resistance as defined by the European Committee on Antimicrobial Susceptibility Testing (EUCAST, https://eucast.org), see Source. Use eucast_dosage() to get a data.frame with advised dosages of a certain bug-drug combination, which is based on the dosage data set.
2020-09-24 00:30:11 +02:00
To improve the interpretation of the antibiogram before EUCAST rules are applied, some non-EUCAST rules can applied at default, see Details." />
<meta property="og:image" content="https://msberends.github.io/AMR/logo.png" />
2018-12-23 21:26:21 +01: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]-->
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.6.0.9007</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">
2020-12-21 22:46:29 +01:00
<span class="fas fa-home"></span>
2018-12-29 22:24:19 +01:00
Home
</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">
2020-12-21 22:46:29 +01:00
<span class="fas fa-question-circle"></span>
2019-01-02 23:24:07 +01:00
How to
2018-12-23 21:26:21 +01:00
2019-01-02 23:24:07 +01:00
<span class="caret"></span>
2018-12-23 21:26:21 +01:00
</a>
2019-01-02 23:24:07 +01:00
<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-01-02 23:24:07 +01:00
Conduct AMR analysis
</a>
</li>
<li>
2019-02-14 10:23:51 +01:00
<a href="../articles/resistance_predict.html">
2020-12-21 22:46:29 +01:00
<span class="fas fa-dice"></span>
2019-01-02 23:24:07 +01:00
Predict antimicrobial resistance
</a>
</li>
2020-08-21 11:40:13 +02:00
<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>
</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-23 16:58:59 +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-23 16:58:59 +02:00
Determine multi-drug resistance (MDR)
</a>
</li>
2019-01-29 00:06:50 +01:00
<li>
<a href="../articles/WHONET.html">
2020-12-21 22:46:29 +01:00
<span class="fas fa-globe-americas"></span>
2019-01-29 00:06:50 +01:00
Work with WHONET data
</a>
</li>
2019-02-14 15:18:17 +01:00
<li>
<a href="../articles/SPSS.html">
2020-12-21 22:46:29 +01:00
<span class="fas fa-file-upload"></span>
2019-02-14 15:18:17 +01:00
Import data from SPSS/SAS/Stata
</a>
</li>
2019-01-02 23:24:07 +01:00
<li>
<a href="../articles/EUCAST.html">
2020-12-21 22:46:29 +01:00
<span class="fas fa-exchange-alt"></span>
2019-01-02 23:24:07 +01:00
Apply EUCAST rules
</a>
</li>
<li>
2019-02-14 10:23:51 +01:00
<a href="../reference/mo_property.html">
2020-12-21 22:46:29 +01:00
<span class="fas fa-bug"></span>
2019-01-02 23:24:07 +01:00
Get properties of a microorganism
</a>
</li>
<li>
2019-05-10 16:44:59 +02:00
<a href="../reference/ab_property.html">
2020-12-21 22:46:29 +01:00
<span class="fas fa-capsules"></span>
2019-01-02 23:24:07 +01:00
Get properties of an antibiotic
</a>
</li>
2019-01-11 20:37:23 +01:00
<li>
<a href="../articles/benchmarks.html">
2020-12-21 22:46:29 +01:00
<span class="fas fa-shipping-fast"></span>
2019-01-11 20:37:23 +01:00
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">
2020-12-21 22:46:29 +01:00
<span class="fas fa-book-open"></span>
2018-12-29 22:24:19 +01:00
Manual
</a>
2018-12-23 21:26:21 +01:00
</li>
<li>
2018-12-29 22:24:19 +01:00
<a href="../authors.html">
2020-12-21 22:46:29 +01:00
<span class="fas fa-users"></span>
2018-12-29 22:24:19 +01:00
Authors
</a>
2018-12-23 21:26:21 +01:00
</li>
2018-12-29 22:24:19 +01:00
<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>
2018-12-23 21:26:21 +01:00
2018-12-29 22:24:19 +01:00
Changelog
2018-12-23 21:26:21 +01:00
</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">
2020-12-21 22:46:29 +01:00
<span class="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">
2020-12-21 22:46:29 +01:00
<span class="fas 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 -->
2018-12-23 21:26:21 +01:00
</header>
<div class="row">
<div class="col-md-9 contents">
<div class="page-header">
<h1>Apply EUCAST Rules</h1>
2020-07-08 14:48:06 +02:00
<small class="dont-index">Source: <a href='https://github.com/msberends/AMR/blob/master/R/eucast_rules.R'><code>R/eucast_rules.R</code></a></small>
2018-12-23 21:26:21 +01:00
<div class="hidden name"><code>eucast_rules.Rd</code></div>
</div>
<div class="ref-description">
<p>Apply rules for clinical breakpoints and intrinsic resistance as defined by the European Committee on Antimicrobial Susceptibility Testing (EUCAST, <a href='https://eucast.org'>https://eucast.org</a>), see <em>Source</em>. Use <code>eucast_dosage()</code> to get a <a href='https://rdrr.io/r/base/data.frame.html'>data.frame</a> with advised dosages of a certain bug-drug combination, which is based on the <a href='dosage.html'>dosage</a> data set.</p>
<p>To improve the interpretation of the antibiogram before EUCAST rules are applied, some non-EUCAST rules can applied at default, see <em>Details</em>.</p>
2018-12-23 21:26:21 +01:00
</div>
<pre class="usage"><span class='fu'>eucast_rules</span><span class='op'>(</span>
<span class='va'>x</span>,
col_mo <span class='op'>=</span> <span class='cn'>NULL</span>,
info <span class='op'>=</span> <span class='fu'><a href='https://rdrr.io/r/base/interactive.html'>interactive</a></span><span class='op'>(</span><span class='op'>)</span>,
rules <span class='op'>=</span> <span class='fu'><a href='https://rdrr.io/r/base/options.html'>getOption</a></span><span class='op'>(</span><span class='st'>"AMR_eucastrules"</span>, default <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='st'>"breakpoints"</span>, <span class='st'>"expert"</span><span class='op'>)</span><span class='op'>)</span>,
verbose <span class='op'>=</span> <span class='cn'>FALSE</span>,
version_breakpoints <span class='op'>=</span> <span class='fl'>11</span>,
version_expertrules <span class='op'>=</span> <span class='fl'>3.2</span>,
ampc_cephalosporin_resistance <span class='op'>=</span> <span class='cn'>NA</span>,
only_rsi_columns <span class='op'>=</span> <span class='cn'>FALSE</span>,
2021-04-07 08:37:42 +02:00
custom_rules <span class='op'>=</span> <span class='cn'>NULL</span>,
<span class='va'>...</span>
<span class='op'>)</span>
<span class='fu'>eucast_dosage</span><span class='op'>(</span><span class='va'>ab</span>, administration <span class='op'>=</span> <span class='st'>"iv"</span>, version_breakpoints <span class='op'>=</span> <span class='fl'>11</span><span class='op'>)</span></pre>
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>
2019-04-05 18:47:39 +02:00
<th>x</th>
2020-09-24 00:30:11 +02:00
<td><p>data with antibiotic columns, such as <code>amox</code>, <code>AMX</code> and <code>AMC</code></p></td>
2018-12-23 21:26:21 +01:00
</tr>
<tr>
<th>col_mo</th>
<td><p>column name of the IDs of the microorganisms (see <code><a href='as.mo.html'>as.mo()</a></code>), defaults to the first column of class <code><a href='as.mo.html'>mo</a></code>. Values will be coerced using <code><a href='as.mo.html'>as.mo()</a></code>.</p></td>
2018-12-23 21:26:21 +01:00
</tr>
<tr>
<th>info</th>
2020-10-04 19:26:43 +02:00
<td><p>a logical to indicate whether progress should be printed to the console, defaults to only print while in interactive sessions</p></td>
2018-12-23 21:26:21 +01:00
</tr>
<tr>
<th>rules</th>
2021-04-07 08:37:42 +02:00
<td><p>a character vector that specifies which rules should be applied. Must be one or more of <code>"breakpoints"</code>, <code>"expert"</code>, <code>"other"</code>, <code>"custom"</code>, <code>"all"</code>, and defaults to <code><a href='https://rdrr.io/r/base/c.html'>c("breakpoints", "expert")</a></code>. The default value can be set to another value, e.g. using <code><a href='https://rdrr.io/r/base/options.html'>options(AMR_eucastrules = "all")</a></code>. If using <code>"custom"</code>, be sure to fill in argument <code>custom_rules</code> too. Custom rules can be created with <code><a href='custom_eucast_rules.html'>custom_eucast_rules()</a></code>.</p></td>
2018-12-23 21:26:21 +01:00
</tr>
<tr>
<th>verbose</th>
2020-09-24 00:30:11 +02:00
<td><p>a <a href='https://rdrr.io/r/base/logical.html'>logical</a> to turn Verbose mode on and off (default is off). In Verbose mode, the function does not apply rules to the data, but instead returns a data set in logbook form with extensive info about which rows and columns would be effected and in which way. Using Verbose mode takes a lot more time.</p></td>
</tr>
<tr>
<th>version_breakpoints</th>
<td><p>the version number to use for the EUCAST Clinical Breakpoints guideline. Can be either "11.0" or "10.0".</p></td>
2020-09-24 00:30:11 +02:00
</tr>
<tr>
<th>version_expertrules</th>
<td><p>the version number to use for the EUCAST Expert Rules and Intrinsic Resistance guideline. Can be either "3.2" or "3.1".</p></td>
2018-12-23 21:26:21 +01:00
</tr>
<tr>
<th>ampc_cephalosporin_resistance</th>
2021-03-11 21:42:30 +01:00
<td><p>a character value that should be applied to cefotaxime, ceftriaxone and ceftazidime for AmpC de-repressed cephalosporin-resistant mutants, defaults to <code>NA</code>. Currently only works when <code>version_expertrules</code> is <code>3.2</code>; '<em>EUCAST Expert Rules v3.2 on Enterobacterales</em>' states that results of cefotaxime, ceftriaxone and ceftazidime should be reported with a note, or results should be suppressed (emptied) for these three agents. A value of <code>NA</code> (the default) for this argument will remove results for these three agents, while e.g. a value of <code>"R"</code> will make the results for these agents resistant. Use <code>NULL</code> or <code>FALSE</code> to not alter results for these three agents of AmpC de-repressed cephalosporin-resistant mutants. Using <code>TRUE</code> is equal to using <code>"R"</code>. <br /> For <em>EUCAST Expert Rules</em> v3.2, this rule applies to: <em>Citrobacter braakii</em>, <em>Citrobacter freundii</em>, <em>Citrobacter gillenii</em>, <em>Citrobacter murliniae</em>, <em>Citrobacter rodenticum</em>, <em>Citrobacter sedlakii</em>, <em>Citrobacter werkmanii</em>, <em>Citrobacter youngae</em>, <em>Enterobacter</em>, <em>Hafnia alvei</em>, <em>Klebsiella aerogenes</em>, <em>Morganella morganii</em>, <em>Providencia</em> and <em>Serratia</em>.</p></td>
</tr>
<tr>
<th>only_rsi_columns</th>
2021-03-11 21:42:30 +01:00
<td><p>a logical to indicate whether only antibiotic columns must be detected that were transformed to class <code>&lt;rsi&gt;</code> (see <code><a href='as.rsi.html'>as.rsi()</a></code>) on beforehand (defaults to <code>FALSE</code>)</p></td>
</tr>
2021-04-07 08:37:42 +02:00
<tr>
<th>custom_rules</th>
<td><p>custom rules to apply, created with <code><a href='custom_eucast_rules.html'>custom_eucast_rules()</a></code></p></td>
</tr>
2018-12-23 21:26:21 +01:00
<tr>
<th>...</th>
<td><p>column name of an antibiotic, see section <em>Antibiotics</em> below</p></td>
2018-12-23 21:26:21 +01:00
</tr>
<tr>
<th>ab</th>
<td><p>any (vector of) text that can be coerced to a valid antibiotic code with <code><a href='as.ab.html'>as.ab()</a></code></p></td>
</tr>
<tr>
<th>administration</th>
<td><p>route of administration, either "im", "iv" or "oral"</p></td>
</tr>
2018-12-23 21:26:21 +01:00
</table>
2018-12-23 21:26:21 +01:00
<h2 class="hasAnchor" id="source"><a class="anchor" href="#source"></a>Source</h2>
<ul>
<li><p>EUCAST Expert Rules. Version 2.0, 2012.<br />
2021-01-06 11:16:17 +01:00
Leclercq et al. <strong>EUCAST expert rules in antimicrobial susceptibility testing.</strong> <em>Clin Microbiol Infect.</em> 2013;19(2):141-60; doi: <a href='https://doi.org/10.1111/j.1469-0691.2011.03703.x'>10.1111/j.1469-0691.2011.03703.x</a></p></li>
<li><p>EUCAST Expert Rules, Intrinsic Resistance and Exceptional Phenotypes Tables. Version 3.1, 2016. <a href='https://www.eucast.org/fileadmin/src/media/PDFs/EUCAST_files/Expert_Rules/Expert_rules_intrinsic_exceptional_V3.1.pdf'>(link)</a></p></li>
<li><p>EUCAST Intrinsic Resistance and Unusual Phenotypes. Version 3.2, 2020. <a href='https://www.eucast.org/fileadmin/src/media/PDFs/EUCAST_files/Expert_Rules/2020/Intrinsic_Resistance_and_Unusual_Phenotypes_Tables_v3.2_20200225.pdf'>(link)</a></p></li>
<li><p>EUCAST Breakpoint tables for interpretation of MICs and zone diameters. Version 9.0, 2019. <a href='https://www.eucast.org/fileadmin/src/media/PDFs/EUCAST_files/Breakpoint_tables/v_9.0_Breakpoint_Tables.xlsx'>(link)</a></p></li>
<li><p>EUCAST Breakpoint tables for interpretation of MICs and zone diameters. Version 10.0, 2020. <a href='https://www.eucast.org/fileadmin/src/media/PDFs/EUCAST_files/Breakpoint_tables/v_10.0_Breakpoint_Tables.xlsx'>(link)</a></p></li>
<li><p>EUCAST Breakpoint tables for interpretation of MICs and zone diameters. Version 11.0, 2021. <a href='https://www.eucast.org/fileadmin/src/media/PDFs/EUCAST_files/Breakpoint_tables/v_11.0_Breakpoint_Tables.xlsx'>(link)</a></p></li>
2018-12-23 21:26:21 +01:00
</ul>
2018-12-23 21:26:21 +01:00
<h2 class="hasAnchor" id="value"><a class="anchor" href="#value"></a>Value</h2>
<p>The input of <code>x</code>, possibly with edited values of antibiotics. Or, if <code>verbose = TRUE</code>, a <a href='https://rdrr.io/r/base/data.frame.html'>data.frame</a> with all original and new values of the affected bug-drug combinations.</p>
2019-04-05 18:47:39 +02:00
<h2 class="hasAnchor" id="details"><a class="anchor" href="#details"></a>Details</h2>
<p><strong>Note:</strong> This function does not translate MIC values to RSI values. Use <code><a href='as.rsi.html'>as.rsi()</a></code> for that. <br />
<strong>Note:</strong> When ampicillin (AMP, J01CA01) is not available but amoxicillin (AMX, J01CA04) is, the latter will be used for all rules where there is a dependency on ampicillin. These drugs are interchangeable when it comes to expression of antimicrobial resistance. <br /></p>
<p>The file containing all EUCAST rules is located here: <a href='https://github.com/msberends/AMR/blob/master/data-raw/eucast_rules.tsv'>https://github.com/msberends/AMR/blob/master/data-raw/eucast_rules.tsv</a>. <strong>Note:</strong> Old taxonomic names are replaced with the current taxonomy where applicable. For example, <em>Ochrobactrum anthropi</em> was renamed to <em>Brucella anthropi</em> in 2020; the original EUCAST rules v3.1 and v3.2 did not yet contain this new taxonomic name. The file used as input for this <code>AMR</code> package contains the taxonomy updated until <a href='catalogue_of_life.html'>March 2021</a>.</p><h3 class='hasAnchor' id='arguments'><a class='anchor' href='#arguments'></a>Custom Rules</h3>
2021-04-07 08:37:42 +02:00
<p>Custom rules can be created using <code><a href='custom_eucast_rules.html'>custom_eucast_rules()</a></code>, e.g.:</p><pre><span class='va'>x</span> <span class='op'>&lt;-</span> <span class='fu'><a href='custom_eucast_rules.html'>custom_eucast_rules</a></span><span class='op'>(</span><span class='va'>AMC</span> <span class='op'>==</span> <span class='st'>"R"</span> <span class='op'>&amp;</span> <span class='va'>genus</span> <span class='op'>==</span> <span class='st'>"Klebsiella"</span> <span class='op'>~</span> <span class='va'>aminopenicillins</span> <span class='op'>==</span> <span class='st'>"R"</span>,
<span class='va'>AMC</span> <span class='op'>==</span> <span class='st'>"I"</span> <span class='op'>&amp;</span> <span class='va'>genus</span> <span class='op'>==</span> <span class='st'>"Klebsiella"</span> <span class='op'>~</span> <span class='va'>aminopenicillins</span> <span class='op'>==</span> <span class='st'>"I"</span><span class='op'>)</span>
<span class='fu'>eucast_rules</span><span class='op'>(</span><span class='va'>example_isolates</span>, rules <span class='op'>=</span> <span class='st'>"custom"</span>, custom_rules <span class='op'>=</span> <span class='va'>x</span><span class='op'>)</span>
</pre>
<h3 class='hasAnchor' id='arguments'><a class='anchor' href='#arguments'></a>'Other' Rules</h3>
2020-09-24 00:30:11 +02:00
<p>Before further processing, two non-EUCAST rules about drug combinations can be applied to improve the efficacy of the EUCAST rules, and the reliability of your data (analysis). These rules are:</p><ol>
<li><p>A drug <strong>with</strong> enzyme inhibitor will be set to S if the same drug <strong>without</strong> enzyme inhibitor is S</p></li>
<li><p>A drug <strong>without</strong> enzyme inhibitor will be set to R if the same drug <strong>with</strong> enzyme inhibitor is R</p></li>
</ol>
2020-09-24 00:30:11 +02:00
<p>Important examples include amoxicillin and amoxicillin/clavulanic acid, and trimethoprim and trimethoprim/sulfamethoxazole. Needless to say, for these rules to work, both drugs must be available in the data set.</p>
2021-01-06 11:16:17 +01:00
<p>Since these rules are not officially approved by EUCAST, they are not applied at default. To use these rules, include <code>"other"</code> to the <code>rules</code> argument, or use <code>eucast_rules(..., rules = "all")</code>. You can also set the option <code>AMR_eucastrules</code>, i.e. run <code><a href='https://rdrr.io/r/base/options.html'>options(AMR_eucastrules = "all")</a></code>.</p>
2020-09-24 00:30:11 +02:00
2018-12-23 21:26:21 +01:00
<h2 class="hasAnchor" id="antibiotics"><a class="anchor" href="#antibiotics"></a>Antibiotics</h2>
<p>To define antibiotics column names, leave as it is to determine it automatically with <code><a href='guess_ab_col.html'>guess_ab_col()</a></code> or input a text (case-insensitive), or use <code>NULL</code> to skip a column (e.g. <code>TIC = NULL</code> to skip ticarcillin). Manually defined but non-existing columns will be skipped with a warning.</p>
2020-09-24 00:30:11 +02:00
<p>The following antibiotics are used for the functions <code>eucast_rules()</code> and <code><a href='mdro.html'>mdro()</a></code>. These are shown below in the format 'name (<code>antimicrobial ID</code>, <a href='https://www.whocc.no/atc/structure_and_principles/'>ATC code</a>)', sorted alphabetically:</p>
2021-03-11 21:42:30 +01:00
<p>Amikacin (<code>AMK</code>, <a href='https://www.whocc.no/atc_ddd_index/?code=J01GB06&amp;showdescription=no'>J01GB06</a>), amoxicillin (<code>AMX</code>, <a href='https://www.whocc.no/atc_ddd_index/?code=J01CA04&amp;showdescription=no'>J01CA04</a>), amoxicillin/clavulanic acid (<code>AMC</code>, <a href='https://www.whocc.no/atc_ddd_index/?code=J01CR02&amp;showdescription=no'>J01CR02</a>), ampicillin (<code>AMP</code>, <a href='https://www.whocc.no/atc_ddd_index/?code=J01CA01&amp;showdescription=no'>J01CA01</a>), ampicillin/sulbactam (<code>SAM</code>, <a href='https://www.whocc.no/atc_ddd_index/?code=J01CR01&amp;showdescription=no'>J01CR01</a>), apalcillin (<code>APL</code>, no ATC code), aspoxicillin (<code>APX</code>, no ATC code), avibactam (<code>AVB</code>, no ATC code), avoparcin (<code>AVO</code>, no ATC code), azidocillin (<code>AZD</code>, <a href='https://www.whocc.no/atc_ddd_index/?code=J01CE04&amp;showdescription=no'>J01CE04</a>), azithromycin (<code>AZM</code>, <a href='https://www.whocc.no/atc_ddd_index/?code=J01FA10&amp;showdescription=no'>J01FA10</a>), azlocillin (<code>AZL</code>, <a href='https://www.whocc.no/atc_ddd_index/?code=J01CA09&amp;showdescription=no'>J01CA09</a>), aztreonam (<code>ATM</code>, <a href='https://www.whocc.no/atc_ddd_index/?code=J01DF01&amp;showdescription=no'>J01DF01</a>), bacampicillin (<code>BAM</code>, <a href='https://www.whocc.no/atc_ddd_index/?code=J01CA06&amp;showdescription=no'>J01CA06</a>), benzylpenicillin (<code>PEN</code>, <a href='https://www.whocc.no/atc_ddd_index/?code=J01CE01&amp;showdescription=no'>J01CE01</a>), cadazolid (<code>CDZ</code>, <a href='https://www.whocc.no/atc_ddd_index/?code=J01DD09&amp;showdescription=no'>J01DD09</a>), carbenicillin (<code>CRB</code>, <a href='https://www.whocc.no/atc_ddd_index/?code=J01CA03&amp;showdescription=no'>J01CA03</a>), carindacillin (<code>CRN</code>, <a href='https://www.whocc.no/atc_ddd_index/?code=J01CA05&amp;showdescription=no'>J01CA05</a>), cefacetrile (<code>CAC</code>, <a href='https://www.whocc.no/atc_ddd_index/?code=J01DB10&amp;showdescription=no'>J01DB10</a>), cefaclor (<code>CEC</code>, <a href='https://www.whocc.no/atc_ddd_index/?code=J01DC04&amp;showdescription=no'>J01DC04</a>), cefadroxil (<code>CFR</code>, <a href='https://www.whocc.no/atc_ddd_index/?code=J01DB05&amp;showdescription=no'>J01DB05</a>), cefaloridine (<code>RID</code>, <a href='https://www.whocc.no/atc_ddd_index/?code=J01DB02&amp;showdescription=no'>J01DB02</a>), cefamandole (<code>MAN</code>, <a href='https://www.whocc.no/atc_ddd_index/?code=J01DC03&amp;showdescription=no'>J01DC03</a>), cefatrizine (<code>CTZ</code>, <a href='https://www.whocc.no/atc_ddd_index/?code=J01DB07&amp;showdescription=no'>J01DB07</a>), cefazedone (<code>CZD</code>, <a href='https://www.whocc.no/atc_ddd_index/?code=J01DB06&amp;showdescription=no'>J01DB06</a>), cefazolin (<code>CZO</code>, <a href='https://www.whocc.no/atc_ddd_index/?code=J01DB04&amp;showdescription=no'>J01DB04</a>), cefcapene (<code>CCP</code>, no ATC code), cefcapene pivoxil (<code>CCX</code>, no ATC code), cefdinir (<code>CDR</code>, <a href='https://www.whocc.no/atc_ddd_index/?code=J01DD15&amp;showdescription=no'>J01DD15</a>), cefditoren (<code>DIT</code>, <a href='https://www.whocc.no/atc_ddd_index/?code=J01DD16&amp;showdescription=no'>J01DD16</a>), cefditoren pivoxil (<code>DIX</code>, no ATC code), cefepime (<code>FEP</code>, <a href='https://www.whocc.no/atc_ddd_index/?code=J01DE01&amp;showdescription=no'>J01DE01</a>), cefetamet (<code>CAT</code>, <a href='https://www.whocc.no/atc_ddd_index/?code=J01DD10&amp;showdescription=no'>J01DD10</a>), cefetamet pivoxil (<code>CPI</code>, no ATC code), cefixime (<code>CFM</code>, <a href='https://www.whocc.no/atc_ddd_index/?code=J01DD08&amp;showdescription=no'>J01DD08</a>), cefmenoxime (<code>CMX</code>, <a href='https://www.whocc.no/atc_ddd_index/?code=J01DD05&amp;showdescription=no'>J01DD05</a>), cefmetazole (<code>CMZ</code>, <a href='https://www.whocc.no/atc_ddd_index/?code=J01DC09&amp;showdescription=no'>J01DC09</a>), cefodizime (<code>DIZ</cod
<h2 class="hasAnchor" id="stable-lifecycle"><a class="anchor" href="#stable-lifecycle"></a>Stable Lifecycle</h2>
2020-09-24 00:30:11 +02:00
<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>
<h2 class="hasAnchor" id="reference-data-publicly-available"><a class="anchor" href="#reference-data-publicly-available"></a>Reference Data Publicly Available</h2>
2020-08-21 11:40:13 +02:00
<p>All reference data sets (about microorganisms, antibiotics, R/SI interpretation, EUCAST rules, etc.) in this <code>AMR</code> package are publicly and freely available. We continually export our data sets to formats for use in R, SPSS, SAS, Stata and Excel. We also supply flat files that are machine-readable and suitable for input in any software program, such as laboratory information systems. Please find <a href='https://msberends.github.io/AMR/articles/datasets.html'>all download links on our website</a>, which is automatically updated with every code change.</p>
<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-01-02 23:24:07 +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>
2018-12-23 21:26:21 +01:00
<h2 class="hasAnchor" id="examples"><a class="anchor" href="#examples"></a>Examples</h2>
<pre class="examples"><span class='co'># \donttest{</span>
<span class='va'>a</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>mo <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='st'>"Staphylococcus aureus"</span>,
2018-12-23 21:26:21 +01:00
<span class='st'>"Enterococcus faecalis"</span>,
<span class='st'>"Escherichia coli"</span>,
<span class='st'>"Klebsiella pneumoniae"</span>,
<span class='st'>"Pseudomonas aeruginosa"</span><span class='op'>)</span>,
VAN <span class='op'>=</span> <span class='st'>"-"</span>, <span class='co'># Vancomycin</span>
AMX <span class='op'>=</span> <span class='st'>"-"</span>, <span class='co'># Amoxicillin</span>
COL <span class='op'>=</span> <span class='st'>"-"</span>, <span class='co'># Colistin</span>
CAZ <span class='op'>=</span> <span class='st'>"-"</span>, <span class='co'># Ceftazidime</span>
CXM <span class='op'>=</span> <span class='st'>"-"</span>, <span class='co'># Cefuroxime</span>
PEN <span class='op'>=</span> <span class='st'>"S"</span>, <span class='co'># Benzylpenicillin</span>
FOX <span class='op'>=</span> <span class='st'>"S"</span>, <span class='co'># Cefoxitin</span>
stringsAsFactors <span class='op'>=</span> <span class='cn'>FALSE</span><span class='op'>)</span>
<span class='va'>a</span>
2019-05-10 16:44:59 +02:00
<span class='co'># mo VAN AMX COL CAZ CXM PEN FOX</span>
2018-12-23 21:26:21 +01:00
<span class='co'># 1 Staphylococcus aureus - - - - - S S</span>
<span class='co'># 2 Enterococcus faecalis - - - - - S S</span>
<span class='co'># 3 Escherichia coli - - - - - S S</span>
<span class='co'># 4 Klebsiella pneumoniae - - - - - S S</span>
<span class='co'># 5 Pseudomonas aeruginosa - - - - - S S</span>
2019-02-08 16:06:54 +01:00
2020-09-24 00:30:11 +02:00
<span class='co'># apply EUCAST rules: some results wil be changed</span>
<span class='va'>b</span> <span class='op'>&lt;-</span> <span class='fu'>eucast_rules</span><span class='op'>(</span><span class='va'>a</span><span class='op'>)</span>
2019-01-02 23:24:07 +01:00
<span class='va'>b</span>
2019-05-10 16:44:59 +02:00
<span class='co'># mo VAN AMX COL CAZ CXM PEN FOX</span>
2019-01-02 23:24:07 +01:00
<span class='co'># 1 Staphylococcus aureus - S R R S S S</span>
<span class='co'># 2 Enterococcus faecalis - - R R R S R</span>
<span class='co'># 3 Escherichia coli R - - - - R S</span>
<span class='co'># 4 Klebsiella pneumoniae R R - - - R S</span>
<span class='co'># 5 Pseudomonas aeruginosa R R - - R R R</span>
2019-02-08 16:06:54 +01:00
2019-07-30 13:12:40 +02:00
<span class='co'># do not apply EUCAST rules, but rather get a data.frame</span>
2020-09-24 00:30:11 +02:00
<span class='co'># containing all details about the transformations:</span>
<span class='va'>c</span> <span class='op'>&lt;-</span> <span class='fu'>eucast_rules</span><span class='op'>(</span><span class='va'>a</span>, verbose <span class='op'>=</span> <span class='cn'>TRUE</span><span class='op'>)</span>
<span class='co'># }</span>
<span class='fu'>eucast_dosage</span><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='st'>"tobra"</span>, <span class='st'>"genta"</span>, <span class='st'>"cipro"</span><span class='op'>)</span>, <span class='st'>"iv"</span><span class='op'>)</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>
2018-12-23 21:26:21 +01: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>
2018-12-23 21:26:21 +01:00
</div>
<div class="pkgdown">
<p>Site built with <a href="https://pkgdown.r-lib.org/">pkgdown</a> 1.6.1.</p>
2018-12-23 21:26:21 +01:00
</div>
2018-12-23 21:26:21 +01:00
</footer>
</div>
2018-12-23 21:26:21 +01:00
</body>
</html>