1
0
mirror of https://github.com/msberends/AMR.git synced 2024-12-26 06:46:11 +01:00
AMR/reference/eucast_rules.html

396 lines
70 KiB
HTML
Raw Normal View History

2022-08-21 16:59:35 +02:00
<!DOCTYPE html>
2022-10-05 12:32:07 +02:00
<!-- Generated by pkgdown: do not edit by hand --><html lang="en"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><meta charset="utf-8"><meta http-equiv="X-UA-Compatible" content="IE=edge"><meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no"><meta name="description" content="Apply rules for clinical breakpoints and intrinsic resistance as defined by the European Committee on Antimicrobial Susceptibility Testing (EUCAST, https://www.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.
To improve the interpretation of the antibiogram before EUCAST rules are applied, some non-EUCAST rules can applied at default, see Details."><title>Apply EUCAST Rules — eucast_rules • AMR (for R)</title><!-- favicons --><link rel="icon" type="image/png" sizes="16x16" href="../favicon-16x16.png"><link rel="icon" type="image/png" sizes="32x32" href="../favicon-32x32.png"><link rel="apple-touch-icon" type="image/png" sizes="180x180" href="../apple-touch-icon.png"><link rel="apple-touch-icon" type="image/png" sizes="120x120" href="../apple-touch-icon-120x120.png"><link rel="apple-touch-icon" type="image/png" sizes="76x76" href="../apple-touch-icon-76x76.png"><link rel="apple-touch-icon" type="image/png" sizes="60x60" href="../apple-touch-icon-60x60.png"><script src="../deps/jquery-3.6.0/jquery-3.6.0.min.js"></script><meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no"><link href="../deps/bootstrap-5.1.3/bootstrap.min.css" rel="stylesheet"><script src="../deps/bootstrap-5.1.3/bootstrap.bundle.min.js"></script><link href="../deps/Fira_Code-0.4.2/font.css" rel="stylesheet"><!-- 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"><!-- bootstrap-toc --><script src="https://cdn.rawgit.com/afeld/bootstrap-toc/v1.0.1/dist/bootstrap-toc.min.js"></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><!-- 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><!-- search --><script src="https://cdnjs.cloudflare.com/ajax/libs/fuse.js/6.4.6/fuse.js" integrity="sha512-zv6Ywkjyktsohkbp9bb45V6tEMoWhzFzXis+LrMehmJZZSys19Yxf1dopHx7WzIKxr5tK2dVcYmaCk2uqdjF4A==" crossorigin="anonymous"></script><script src="https://cdnjs.cloudflare.com/ajax/libs/autocomplete.js/0.38.0/autocomplete.jquery.min.js" integrity="sha512-GU9ayf+66Xx2TmpxqJpliWbT5PiGYxpaG8rfnBEk1LL8l1KGkRShhngwdXK1UgqhAzWpZHSiYPc09/NwDQIGyg==" crossorigin="anonymous"></script><script src="https://cdnjs.cloudflare.com/ajax/libs/mark.js/8.11.1/mark.min.js" integrity="sha512-5CYOlHXGh6QpOFA/TeTylKLWfB3ftPsde7AnmhuitiTX4K5SqCLBeKro6sPS8ilsz1Q4NRx3v8Ko2IBiszzdww==" crossorigin="anonymous"></script><!-- pkgdown --><script src="../pkgdown.js"></script><link href="../extra.css" rel="stylesheet"><script src="../extra.js"></script><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://www.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.
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.svg"><meta name="twitter:card" content="summary_large_image"><meta name="twitter:creator" content="@msberends"><meta name="twitter:site" content="@msberends"><!-- 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]>
2022-08-21 16:59:35 +02:00
<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>
<a href="#main" class="visually-hidden-focusable">Skip to contents</a>
<nav class="navbar fixed-top navbar-dark navbar-expand-lg bg-primary"><div class="container">
<a class="navbar-brand me-2" href="../index.html">AMR (for R)</a>
2022-11-13 13:52:01 +01:00
<small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="">1.8.2.9050</small>
2022-08-21 16:59:35 +02:00
<button class="navbar-toggler" type="button" data-bs-toggle="collapse" data-bs-target="#navbar" aria-controls="navbar" aria-expanded="false" aria-label="Toggle navigation">
<span class="navbar-toggler-icon"></span>
</button>
<div id="navbar" class="collapse navbar-collapse ms-3">
<ul class="navbar-nav me-auto"><li class="nav-item">
<a class="nav-link" href="../index.html">
<span class="fa fa-home"></span>
Home
</a>
</li>
<li class="nav-item dropdown">
<a href="#" class="nav-link dropdown-toggle" data-bs-toggle="dropdown" role="button" aria-expanded="false" aria-haspopup="true" id="dropdown--how-to">
<span class="fa fa-question-circle"></span>
How to
</a>
<div class="dropdown-menu" aria-labelledby="dropdown--how-to">
<a class="dropdown-item" href="../articles/AMR.html">
<span class="fa fa-directions"></span>
Conduct AMR analysis
</a>
<a class="dropdown-item" href="../articles/resistance_predict.html">
<span class="fa fa-dice"></span>
Predict antimicrobial resistance
</a>
<a class="dropdown-item" href="../articles/datasets.html">
<span class="fa fa-database"></span>
Data sets for download / own use
</a>
<a class="dropdown-item" href="../articles/PCA.html">
<span class="fa fa-compress"></span>
Conduct principal component analysis for AMR
</a>
<a class="dropdown-item" href="../articles/MDR.html">
<span class="fa fa-skull-crossbones"></span>
Determine multi-drug resistance (MDR)
</a>
<a class="dropdown-item" href="../articles/WHONET.html">
<span class="fa fa-globe-americas"></span>
Work with WHONET data
</a>
<a class="dropdown-item" href="../articles/SPSS.html">
<span class="fa fa-file-upload"></span>
Import data from SPSS/SAS/Stata
</a>
<a class="dropdown-item" href="../articles/EUCAST.html">
<span class="fa fa-exchange-alt"></span>
Apply EUCAST rules
</a>
<a class="dropdown-item" href="../reference/mo_property.html">
<span class="fa fa-bug"></span>
Get properties of a microorganism
</a>
<a class="dropdown-item" href="../reference/ab_property.html">
<span class="fa fa-capsules"></span>
Get properties of an antibiotic
</a>
2022-11-13 08:54:32 +01:00
<a class="dropdown-item" href="../reference/av_property.html">
<span class="fa fa-capsules"></span>
Get properties of an antiviral agent
</a>
2022-08-21 16:59:35 +02:00
</div>
</li>
<li class="active nav-item">
<a class="nav-link" href="../reference/index.html">
<span class="fa fa-book-open"></span>
Manual
</a>
</li>
<li class="nav-item">
<a class="nav-link" href="../authors.html">
<span class="fa fa-users"></span>
Authors
</a>
</li>
<li class="nav-item">
<a class="nav-link" href="../news/index.html">
<span class="far fa far fa-newspaper"></span>
Changelog
</a>
</li>
</ul><form class="form-inline my-2 my-lg-0" role="search">
<input type="search" class="form-control me-sm-2" aria-label="Toggle navigation" name="search-input" data-search-index="../search.json" id="search-input" placeholder="Search for" autocomplete="off"></form>
<ul class="navbar-nav"><li class="nav-item">
<a class="external-link nav-link" href="https://github.com/msberends/AMR">
<span class="fab fa fab fa-github"></span>
Source Code
</a>
</li>
</ul></div>
</div>
</nav><div class="container template-reference-topic">
<div class="row">
<main id="main" class="col-md-9"><div class="page-header">
<img src="../logo.svg" class="logo" alt=""><h1>Apply EUCAST Rules</h1>
<small class="dont-index">Source: <a href="https://github.com/msberends/AMR/blob/HEAD/R/eucast_rules.R" class="external-link"><code>R/eucast_rules.R</code></a></small>
<div class="d-none name"><code>eucast_rules.Rd</code></div>
</div>
<div class="ref-description section level2">
2022-10-05 12:32:07 +02:00
<p>Apply rules for clinical breakpoints and intrinsic resistance as defined by the European Committee on Antimicrobial Susceptibility Testing (EUCAST, <a href="https://www.eucast.org" class="external-link">https://www.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" class="external-link">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>
2022-08-21 16:59:35 +02:00
<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>
</div>
<div class="section level2">
<h2 id="ref-usage">Usage<a class="anchor" aria-label="anchor" href="#ref-usage"></a></h2>
<div class="sourceCode"><pre class="sourceCode r"><code><span><span class="fu">eucast_rules</span><span class="op">(</span></span>
<span> <span class="va">x</span>,</span>
<span> col_mo <span class="op">=</span> <span class="cn">NULL</span>,</span>
<span> info <span class="op">=</span> <span class="fu"><a href="https://rdrr.io/r/base/interactive.html" class="external-link">interactive</a></span><span class="op">(</span><span class="op">)</span>,</span>
<span> rules <span class="op">=</span> <span class="fu"><a href="https://rdrr.io/r/base/options.html" class="external-link">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" class="external-link">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>,</span>
<span> verbose <span class="op">=</span> <span class="cn">FALSE</span>,</span>
<span> version_breakpoints <span class="op">=</span> <span class="fl">11</span>,</span>
<span> version_expertrules <span class="op">=</span> <span class="fl">3.3</span>,</span>
<span> ampc_cephalosporin_resistance <span class="op">=</span> <span class="cn">NA</span>,</span>
<span> only_rsi_columns <span class="op">=</span> <span class="cn">FALSE</span>,</span>
<span> custom_rules <span class="op">=</span> <span class="cn">NULL</span>,</span>
<span> <span class="va">...</span></span>
<span><span class="op">)</span></span>
<span></span>
<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></span></code></pre></div>
</div>
<div class="section level2">
<h2 id="source">Source<a class="anchor" aria-label="anchor" href="#source"></a></h2>
<ul><li><p>EUCAST Expert Rules. Version 2.0, 2012.<br>
Leclercq et al. <strong>EUCAST expert rules in antimicrobial susceptibility testing.</strong> <em>Clin Microbiol Infect.</em> 2013;19(2):141-60; <a href="https://doi.org/10.1111/j.1469-0691.2011.03703.x" class="external-link">doi: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" class="external-link">(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" class="external-link">(link)</a></p></li>
<li><p>EUCAST Intrinsic Resistance and Unusual Phenotypes. Version 3.3, 2021. <a href="https://www.eucast.org/fileadmin/src/media/PDFs/EUCAST_files/Expert_Rules/2021/Intrinsic_Resistance_and_Unusual_Phenotypes_Tables_v3.3_20211018.pdf" class="external-link">(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" class="external-link">(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" class="external-link">(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" class="external-link">(link)</a></p></li>
<li><p>EUCAST Breakpoint tables for interpretation of MICs and zone diameters. Version 12.0, 2022. <a href="https://www.eucast.org/fileadmin/src/media/PDFs/EUCAST_files/Breakpoint_tables/v_12.0_Breakpoint_Tables.xlsx" class="external-link">(link)</a></p></li>
</ul></div>
<div class="section level2">
<h2 id="arguments">Arguments<a class="anchor" aria-label="anchor" href="#arguments"></a></h2>
<dl><dt>x</dt>
2022-08-28 22:45:38 +02:00
<dd><p>a data set with antibiotic columns, such as <code>amox</code>, <code>AMX</code> and <code>AMC</code></p></dd>
2022-08-21 16:59:35 +02:00
<dt>col_mo</dt>
<dd><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></dd>
<dt>info</dt>
<dd><p>a <a href="https://rdrr.io/r/base/logical.html" class="external-link">logical</a> to indicate whether progress should be printed to the console, defaults to only print while in interactive sessions</p></dd>
<dt>rules</dt>
<dd><p>a <a href="https://rdrr.io/r/base/character.html" class="external-link">character</a> 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>c("breakpoints", "expert")</code>. The default value can be set to another value, e.g. using <code>options(AMR_eucastrules = "all")</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></dd>
<dt>verbose</dt>
<dd><p>a <a href="https://rdrr.io/r/base/logical.html" class="external-link">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></dd>
<dt>version_breakpoints</dt>
<dd><p>the version number to use for the EUCAST Clinical Breakpoints guideline. Can be either "11.0" or "10.0".</p></dd>
<dt>version_expertrules</dt>
<dd><p>the version number to use for the EUCAST Expert Rules and Intrinsic Resistance guideline. Can be either "3.3", "3.2" or "3.1".</p></dd>
<dt>ampc_cephalosporin_resistance</dt>
2022-11-13 13:52:01 +01:00
<dd><p>a <a href="https://rdrr.io/r/base/character.html" class="external-link">character</a> 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> and higher; these version of '<em>EUCAST Expert Rules on Enterobacterales</em>' state that results of cefotaxime, ceftriaxone and ceftazidime should be reported with a note, or results should be suppressed (emptied) for these three drugs. A value of <code>NA</code> (the default) for this argument will remove results for these three drugs, while e.g. a value of <code>"R"</code> will make the results for these drugs resistant. Use <code>NULL</code> or <code>FALSE</code> to not alter results for these three drugs 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></dd>
2022-08-21 16:59:35 +02:00
<dt>only_rsi_columns</dt>
2022-10-19 11:58:58 +02:00
<dd><p>a <a href="https://rdrr.io/r/base/logical.html" class="external-link">logical</a> to indicate whether only antibiotic columns must be detected that were transformed to class <code>rsi</code> (see <code><a href="as.rsi.html">as.rsi()</a></code>) on beforehand (defaults to <code>FALSE</code>)</p></dd>
2022-08-21 16:59:35 +02:00
<dt>custom_rules</dt>
<dd><p>custom rules to apply, created with <code><a href="custom_eucast_rules.html">custom_eucast_rules()</a></code></p></dd>
<dt>...</dt>
<dd><p>column name of an antibiotic, see section <em>Antibiotics</em> below</p></dd>
<dt>ab</dt>
2022-11-13 13:52:01 +01:00
<dd><p>any (vector of) text that can be coerced to a valid antibiotic drug code with <code><a href="as.ab.html">as.ab()</a></code></p></dd>
2022-08-21 16:59:35 +02:00
<dt>administration</dt>
<dd><p>route of administration, either "im", "iv" or "oral"</p></dd>
</dl></div>
<div class="section level2">
<h2 id="value">Value<a class="anchor" aria-label="anchor" href="#value"></a></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" class="external-link">data.frame</a> with all original and new values of the affected bug-drug combinations.</p>
</div>
<div class="section level2">
<h2 id="details">Details<a class="anchor" aria-label="anchor" href="#details"></a></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>
2022-10-05 12:32:07 +02:00
<p>The file containing all EUCAST rules is located here: <a href="https://github.com/msberends/AMR/blob/main/data-raw/eucast_rules.tsv" class="external-link">https://github.com/msberends/AMR/blob/main/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 <code>AMR</code> package contains the full microbial taxonomy updated until 12 September, 2022, see <a href="microorganisms.html">microorganisms</a>.</p><div class="section">
2022-08-21 16:59:35 +02:00
<h3 id="custom-rules">Custom Rules<a class="anchor" aria-label="anchor" href="#custom-rules"></a></h3>
<p>Custom rules can be created using <code><a href="custom_eucast_rules.html">custom_eucast_rules()</a></code>, e.g.:</p>
2022-10-05 12:32:07 +02:00
<p></p><div class="sourceCode r"><pre><code><span><span class="va">x</span> <span class="op">&lt;-</span> <span class="fu"><a href="../reference/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>
<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>
<span></span>
<span><span class="fu"><a href="../reference/eucast_rules.html">eucast_rules</a></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></span></code></pre><p></p></div>
2022-08-21 16:59:35 +02:00
</div>
<div class="section">
<h3 id="-other-rules">'Other' Rules<a class="anchor" aria-label="anchor" href="#-other-rules"></a></h3>
<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><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>
<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>options(AMR_eucastrules = "all")</code>.</p>
</div>
</div>
<div class="section level2">
<h2 id="antibiotics">Antibiotics<a class="anchor" aria-label="anchor" href="#antibiotics"></a></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>
<p>The following antibiotics are eligible 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/" class="external-link">ATC code</a>)', sorted alphabetically:</p>
2022-10-30 21:14:42 +01:00
<p>Amikacin (<code>AMK</code>, <a href="https://www.whocc.no/atc_ddd_index/?code=J01GB06&amp;showdescription=no" class="external-link">S01AE08</a>), amoxicillin (<code>AMX</code>, <a href="https://www.whocc.no/atc_ddd_index/?code=J01CA04&amp;showdescription=no" class="external-link">J01MA02</a>), amoxicillin/clavulanic acid (<code>AMC</code>, <a href="https://www.whocc.no/atc_ddd_index/?code=J01CR02&amp;showdescription=no" class="external-link">J01MA23</a>), ampicillin (<code>AMP</code>, <a href="https://www.whocc.no/atc_ddd_index/?code=J01CA01&amp;showdescription=no" class="external-link">J01MA04</a>), ampicillin/sulbactam (<code>SAM</code>, <a href="https://www.whocc.no/atc_ddd_index/?code=J01CR01&amp;showdescription=no" class="external-link">J01MA08</a>), arbekacin (<code>ARB</code>, <a href="https://www.whocc.no/atc_ddd_index/?code=J01GB12&amp;showdescription=no" class="external-link">J01MA19</a>), aspoxicillin (<code>APX</code>, <a href="https://www.whocc.no/atc_ddd_index/?code=J01CA19&amp;showdescription=no" class="external-link">J01MA16</a>), azidocillin (<code>AZD</code>, <a href="https://www.whocc.no/atc_ddd_index/?code=J01CE04&amp;showdescription=no" class="external-link">J01MA15</a>), azithromycin (<code>AZM</code>, <a href="https://www.whocc.no/atc_ddd_index/?code=J01FA10&amp;showdescription=no" class="external-link">J01MA11</a>), azlocillin (<code>AZL</code>, <a href="https://www.whocc.no/atc_ddd_index/?code=J01CA09&amp;showdescription=no" class="external-link">J01MA25</a>), aztreonam (<code>ATM</code>, <a href="https://www.whocc.no/atc_ddd_index/?code=J01DF01&amp;showdescription=no" class="external-link">J01MA12</a>), bacampicillin (<code>BAM</code>, <a href="https://www.whocc.no/atc_ddd_index/?code=J01CA06&amp;showdescription=no" class="external-link">J01MA24</a>), bekanamycin (<code>BEK</code>, <a href="https://www.whocc.no/atc_ddd_index/?code=J01GB13&amp;showdescription=no" class="external-link">J01MA07</a>), benzathine benzylpenicillin (<code>BNB</code>, <a href="https://www.whocc.no/atc_ddd_index/?code=J01CE08&amp;showdescription=no" class="external-link">J01MA14</a>), benzathine phenoxymethylpenicillin (<code>BNP</code>, <a href="https://www.whocc.no/atc_ddd_index/?code=J01CE10&amp;showdescription=no" class="external-link">D10AF05</a>), benzylpenicillin (<code>PEN</code>, <a href="https://www.whocc.no/atc_ddd_index/?code=J01CE01&amp;showdescription=no" class="external-link">J01MA06</a>), besifloxacin (<code>BES</code>, <a href="https://www.whocc.no/atc_ddd_index/?code=S01AE08&amp;showdescription=no" class="external-link">J01MA01</a>), biapenem (<code>BIA</code>, <a href="https://www.whocc.no/atc_ddd_index/?code=J01DH05&amp;showdescription=no" class="external-link">J01MA18</a>), carbenicillin (<code>CRB</code>, <a href="https://www.whocc.no/atc_ddd_index/?code=J01CA03&amp;showdescription=no" class="external-link">J01MA03</a>), carindacillin (<code>CRN</code>, <a href="https://www.whocc.no/atc_ddd_index/?code=J01CA05&amp;showdescription=no" class="external-link">J01MA17</a>), cefacetrile (<code>CAC</code>, <a href="https://www.whocc.no/atc_ddd_index/?code=J01DB10&amp;showdescription=no" class="external-link">J01MA10</a>), cefaclor (<code>CEC</code>, <a href="https://www.whocc.no/atc_ddd_index/?code=J01DC04&amp;showdescription=no" class="external-link">J01MA21</a>), cefadroxil (<code>CFR</code>, <a href="https://www.whocc.no/atc_ddd_index/?code=J01DB05&amp;showdescription=no" class="external-link">J01MA09</a>), cefalexin (<code>LEX</code>, <a href="https://www.whocc.no/atc_ddd_index/?code=J01DB01&amp;showdescription=no" class="external-link">J01MA05</a>), cefaloridine (<code>RID</code>, <a href="https://www.whocc.no/atc_ddd_index/?code=J01DB02&amp;showdescription=no" class="external-link">P01AA05</a>), cefalotin (<code>CEP</code>, <a href="https://www.whocc.no/atc_ddd_index/?code=J01DB03&amp;showdescription=no" class="external-link">J01MA22</a>), cefamandole (<code>MAN</code>, <a href="https://www.whocc.no/atc_ddd_index/?code=J01DC03&amp;showdescription=no" class="external-link">J01MA13</a>), cefapirin
2022-08-21 16:59:35 +02:00
</div>
<div class="section level2">
<h2 id="reference-data-publicly-available">Reference Data Publicly Available<a class="anchor" aria-label="anchor" href="#reference-data-publicly-available"></a></h2>
2022-08-28 22:45:38 +02:00
<p>All data sets in this <code>AMR</code> package (about microorganisms, antibiotics, R/SI interpretation, EUCAST rules, etc.) are publicly and freely available for download in the following formats: R, MS Excel, Apache Feather, Apache Parquet, SPSS, SAS, and Stata. We also provide tab-separated plain text files that are machine-readable and suitable for input in any software program, such as laboratory information systems. Please visit <a href="https://msberends.github.io/AMR/articles/datasets.html">our website for the download links</a>. The actual files are of course available on <a href="https://github.com/msberends/AMR/tree/main/data-raw" class="external-link">our GitHub repository</a>.</p>
2022-08-21 16:59:35 +02:00
</div>
<div class="section level2">
<h2 id="ref-examples">Examples<a class="anchor" aria-label="anchor" href="#ref-examples"></a></h2>
<div class="sourceCode"><pre class="sourceCode r"><code><span class="r-in"><span><span class="co"># \donttest{</span></span></span>
2022-08-28 22:45:38 +02:00
<span class="r-in"><span><span class="va">a</span> <span class="op">&lt;-</span> <span class="fu"><a href="https://rdrr.io/r/base/data.frame.html" class="external-link">data.frame</a></span><span class="op">(</span></span></span>
<span class="r-in"><span> mo <span class="op">=</span> <span class="fu"><a href="https://rdrr.io/r/base/c.html" class="external-link">c</a></span><span class="op">(</span></span></span>
<span class="r-in"><span> <span class="st">"Staphylococcus aureus"</span>,</span></span>
<span class="r-in"><span> <span class="st">"Enterococcus faecalis"</span>,</span></span>
<span class="r-in"><span> <span class="st">"Escherichia coli"</span>,</span></span>
<span class="r-in"><span> <span class="st">"Klebsiella pneumoniae"</span>,</span></span>
<span class="r-in"><span> <span class="st">"Pseudomonas aeruginosa"</span></span></span>
<span class="r-in"><span> <span class="op">)</span>,</span></span>
<span class="r-in"><span> VAN <span class="op">=</span> <span class="st">"-"</span>, <span class="co"># Vancomycin</span></span></span>
<span class="r-in"><span> AMX <span class="op">=</span> <span class="st">"-"</span>, <span class="co"># Amoxicillin</span></span></span>
<span class="r-in"><span> COL <span class="op">=</span> <span class="st">"-"</span>, <span class="co"># Colistin</span></span></span>
<span class="r-in"><span> CAZ <span class="op">=</span> <span class="st">"-"</span>, <span class="co"># Ceftazidime</span></span></span>
<span class="r-in"><span> CXM <span class="op">=</span> <span class="st">"-"</span>, <span class="co"># Cefuroxime</span></span></span>
<span class="r-in"><span> PEN <span class="op">=</span> <span class="st">"S"</span>, <span class="co"># Benzylpenicillin</span></span></span>
<span class="r-in"><span> FOX <span class="op">=</span> <span class="st">"S"</span>, <span class="co"># Cefoxitin</span></span></span>
<span class="r-in"><span> stringsAsFactors <span class="op">=</span> <span class="cn">FALSE</span></span></span>
<span class="r-in"><span><span class="op">)</span></span></span>
2022-08-21 16:59:35 +02:00
<span class="r-in"><span></span></span>
<span class="r-in"><span><span class="fu"><a href="https://rdrr.io/r/utils/head.html" class="external-link">head</a></span><span class="op">(</span><span class="va">a</span><span class="op">)</span></span></span>
<span class="r-out co"><span class="r-pr">#&gt;</span> mo VAN AMX COL CAZ CXM PEN FOX</span>
<span class="r-out co"><span class="r-pr">#&gt;</span> 1 Staphylococcus aureus - - - - - S S</span>
<span class="r-out co"><span class="r-pr">#&gt;</span> 2 Enterococcus faecalis - - - - - S S</span>
<span class="r-out co"><span class="r-pr">#&gt;</span> 3 Escherichia coli - - - - - S S</span>
<span class="r-out co"><span class="r-pr">#&gt;</span> 4 Klebsiella pneumoniae - - - - - S S</span>
<span class="r-out co"><span class="r-pr">#&gt;</span> 5 Pseudomonas aeruginosa - - - - - S S</span>
<span class="r-in"><span></span></span>
<span class="r-in"><span></span></span>
<span class="r-in"><span><span class="co"># apply EUCAST rules: some results wil be changed</span></span></span>
<span class="r-in"><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></span></span>
<span class="r-wrn co"><span class="r-pr">#&gt;</span> <span class="warning">Warning: </span>in `eucast_rules()`: not all columns with antimicrobial results are of</span>
2022-10-19 11:58:58 +02:00
<span class="r-wrn co"><span class="r-pr">#&gt;</span> class 'rsi'. Transform them on beforehand, with e.g.:</span>
2022-08-21 16:59:35 +02:00
<span class="r-wrn co"><span class="r-pr">#&gt;</span> - a %&gt;% as.rsi(CXM:AMX)</span>
<span class="r-wrn co"><span class="r-pr">#&gt;</span> - a %&gt;% mutate_if(is.rsi.eligible, as.rsi)</span>
<span class="r-wrn co"><span class="r-pr">#&gt;</span> - a %&gt;% mutate(across(where(is.rsi.eligible), as.rsi))</span>
<span class="r-in"><span></span></span>
<span class="r-in"><span><span class="fu"><a href="https://rdrr.io/r/utils/head.html" class="external-link">head</a></span><span class="op">(</span><span class="va">b</span><span class="op">)</span></span></span>
<span class="r-out co"><span class="r-pr">#&gt;</span> mo VAN AMX COL CAZ CXM PEN FOX</span>
<span class="r-out co"><span class="r-pr">#&gt;</span> 1 Staphylococcus aureus - S R R S S S</span>
<span class="r-out co"><span class="r-pr">#&gt;</span> 2 Enterococcus faecalis - - R R R S R</span>
<span class="r-out co"><span class="r-pr">#&gt;</span> 3 Escherichia coli R - - - - R S</span>
<span class="r-out co"><span class="r-pr">#&gt;</span> 4 Klebsiella pneumoniae R R - - - R S</span>
<span class="r-out co"><span class="r-pr">#&gt;</span> 5 Pseudomonas aeruginosa R R - - R R R</span>
<span class="r-in"><span></span></span>
<span class="r-in"><span></span></span>
<span class="r-in"><span><span class="co"># do not apply EUCAST rules, but rather get a data.frame</span></span></span>
<span class="r-in"><span><span class="co"># containing all details about the transformations:</span></span></span>
<span class="r-in"><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></span>
<span class="r-wrn co"><span class="r-pr">#&gt;</span> <span class="warning">Warning: </span>in `eucast_rules()`: not all columns with antimicrobial results are of</span>
2022-10-19 11:58:58 +02:00
<span class="r-wrn co"><span class="r-pr">#&gt;</span> class 'rsi'. Transform them on beforehand, with e.g.:</span>
2022-08-21 16:59:35 +02:00
<span class="r-wrn co"><span class="r-pr">#&gt;</span> - a %&gt;% as.rsi(CXM:AMX)</span>
<span class="r-wrn co"><span class="r-pr">#&gt;</span> - a %&gt;% mutate_if(is.rsi.eligible, as.rsi)</span>
<span class="r-wrn co"><span class="r-pr">#&gt;</span> - a %&gt;% mutate(across(where(is.rsi.eligible), as.rsi))</span>
<span class="r-in"><span><span class="fu"><a href="https://rdrr.io/r/utils/head.html" class="external-link">head</a></span><span class="op">(</span><span class="va">c</span><span class="op">)</span></span></span>
<span class="r-out co"><span class="r-pr">#&gt;</span> row col mo_fullname old new rule rule_group</span>
<span class="r-out co"><span class="r-pr">#&gt;</span> 1 1 AMX Staphylococcus aureus - S Breakpoints</span>
<span class="r-out co"><span class="r-pr">#&gt;</span> 2 1 CXM Staphylococcus aureus - S Breakpoints</span>
<span class="r-out co"><span class="r-pr">#&gt;</span> 3 1 CAZ Staphylococcus aureus - R Expert Rules</span>
<span class="r-out co"><span class="r-pr">#&gt;</span> 4 1 COL Staphylococcus aureus - R Expert Rules</span>
<span class="r-out co"><span class="r-pr">#&gt;</span> 5 2 CAZ Enterococcus faecalis - R Expert Rules</span>
<span class="r-out co"><span class="r-pr">#&gt;</span> 6 2 COL Enterococcus faecalis - R Expert Rules</span>
<span class="r-out co"><span class="r-pr">#&gt;</span> rule_name</span>
<span class="r-out co"><span class="r-pr">#&gt;</span> 1 Staphylococcus</span>
<span class="r-out co"><span class="r-pr">#&gt;</span> 2 Staphylococcus</span>
<span class="r-out co"><span class="r-pr">#&gt;</span> 3 Table 4: Intrinsic resistance in gram-positive bacteria</span>
<span class="r-out co"><span class="r-pr">#&gt;</span> 4 Table 4: Intrinsic resistance in gram-positive bacteria</span>
<span class="r-out co"><span class="r-pr">#&gt;</span> 5 Table 4: Intrinsic resistance in gram-positive bacteria</span>
<span class="r-out co"><span class="r-pr">#&gt;</span> 6 Table 4: Intrinsic resistance in gram-positive bacteria</span>
<span class="r-out co"><span class="r-pr">#&gt;</span> rule_source</span>
<span class="r-out co"><span class="r-pr">#&gt;</span> 1 'EUCAST Clinical Breakpoint Tables' v11.0, 2021</span>
<span class="r-out co"><span class="r-pr">#&gt;</span> 2 'EUCAST Clinical Breakpoint Tables' v11.0, 2021</span>
<span class="r-out co"><span class="r-pr">#&gt;</span> 3 'EUCAST Expert Rules' and 'EUCAST Intrinsic Resistance and Unusual Phenotypes' v3.3, 2021</span>
<span class="r-out co"><span class="r-pr">#&gt;</span> 4 'EUCAST Expert Rules' and 'EUCAST Intrinsic Resistance and Unusual Phenotypes' v3.3, 2021</span>
<span class="r-out co"><span class="r-pr">#&gt;</span> 5 'EUCAST Expert Rules' and 'EUCAST Intrinsic Resistance and Unusual Phenotypes' v3.3, 2021</span>
<span class="r-out co"><span class="r-pr">#&gt;</span> 6 'EUCAST Expert Rules' and 'EUCAST Intrinsic Resistance and Unusual Phenotypes' v3.3, 2021</span>
<span class="r-in"><span><span class="co"># }</span></span></span>
<span class="r-in"><span></span></span>
<span class="r-in"><span><span class="co"># Dosage guidelines:</span></span></span>
<span class="r-in"><span></span></span>
<span class="r-in"><span><span class="fu">eucast_dosage</span><span class="op">(</span><span class="fu"><a href="https://rdrr.io/r/base/c.html" class="external-link">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></span></span>
<span class="r-msg co"><span class="r-pr">#&gt;</span> Dosages for antimicrobial drugs, as meant for 'EUCAST Clinical Breakpoint</span>
<span class="r-msg co"><span class="r-pr">#&gt;</span> Tables' v11.0 (2021). This note will be shown once per session.</span>
2022-08-28 22:45:38 +02:00
<span class="r-out co"><span class="r-pr">#&gt;</span> <span style="color: #949494;"># A tibble: 3 × 4</span></span>
<span class="r-out co"><span class="r-pr">#&gt;</span> ab name standard_dosage high_dosage </span>
<span class="r-out co"><span class="r-pr">#&gt;</span> <span style="color: #949494; font-style: italic;">&lt;ab&gt;</span> <span style="color: #949494; font-style: italic;">&lt;chr&gt;</span> <span style="color: #949494; font-style: italic;">&lt;chr&gt;</span> <span style="color: #949494; font-style: italic;">&lt;chr&gt;</span> </span>
<span class="r-out co"><span class="r-pr">#&gt;</span> <span style="color: #BCBCBC;">1</span> TOB Tobramycin 6-7 mg/kg x 1 iv <span style="color: #BB0000;">NA</span> </span>
<span class="r-out co"><span class="r-pr">#&gt;</span> <span style="color: #BCBCBC;">2</span> GEN Gentamicin 6-7 mg/kg x 1 iv <span style="color: #BB0000;">NA</span> </span>
<span class="r-out co"><span class="r-pr">#&gt;</span> <span style="color: #BCBCBC;">3</span> CIP Ciprofloxacin 0.4 g x 2 iv 0.4 g x 3 iv</span>
2022-08-21 16:59:35 +02:00
<span class="r-in"><span></span></span>
<span class="r-in"><span><span class="fu">eucast_dosage</span><span class="op">(</span><span class="fu"><a href="https://rdrr.io/r/base/c.html" class="external-link">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>, version_breakpoints <span class="op">=</span> <span class="fl">10</span><span class="op">)</span></span></span>
<span class="r-msg co"><span class="r-pr">#&gt;</span> Dosages for antimicrobial drugs, as meant for 'EUCAST Clinical Breakpoint</span>
<span class="r-msg co"><span class="r-pr">#&gt;</span> Tables' v10.0 (2020). This note will be shown once per session.</span>
2022-08-28 22:45:38 +02:00
<span class="r-out co"><span class="r-pr">#&gt;</span> <span style="color: #949494;"># A tibble: 3 × 4</span></span>
<span class="r-out co"><span class="r-pr">#&gt;</span> ab name standard_dosage high_dosage </span>
<span class="r-out co"><span class="r-pr">#&gt;</span> <span style="color: #949494; font-style: italic;">&lt;ab&gt;</span> <span style="color: #949494; font-style: italic;">&lt;chr&gt;</span> <span style="color: #949494; font-style: italic;">&lt;chr&gt;</span> <span style="color: #949494; font-style: italic;">&lt;chr&gt;</span> </span>
<span class="r-out co"><span class="r-pr">#&gt;</span> <span style="color: #BCBCBC;">1</span> TOB Tobramycin 6-7 mg/kg x 1 iv <span style="color: #BB0000;">NA</span> </span>
<span class="r-out co"><span class="r-pr">#&gt;</span> <span style="color: #BCBCBC;">2</span> GEN Gentamicin 6-7 mg/kg x 1 iv <span style="color: #BB0000;">NA</span> </span>
<span class="r-out co"><span class="r-pr">#&gt;</span> <span style="color: #BCBCBC;">3</span> CIP Ciprofloxacin 0.4 g x 2 iv 0.4 g x 3 iv</span>
2022-08-21 16:59:35 +02:00
</code></pre></div>
</div>
</main><aside class="col-md-3"><nav id="toc"><h2>On this page</h2>
</nav></aside></div>
<footer><div class="pkgdown-footer-left">
<p></p><p><code>AMR</code> (for R). Developed at the <a target="_blank" href="https://www.rug.nl" class="external-link">University of Groningen</a> in collaboration with non-profit organisations<br><a target="_blank" href="https://www.certe.nl" class="external-link">Certe Medical Diagnostics and Advice Foundation</a> and <a target="_blank" href="https://www.umcg.nl" class="external-link">University Medical Center Groningen</a>.</p>
</div>
<div class="pkgdown-footer-right">
2022-10-05 12:32:07 +02:00
<p></p><p><a target="_blank" href="https://www.rug.nl" class="external-link"><img src="https://github.com/msberends/AMR/raw/main/pkgdown/logos/logo_rug.svg" style="max-width: 150px;"></a></p>
2022-08-21 16:59:35 +02:00
</div>
</footer></div>
</body></html>