mirror of
https://github.com/msberends/AMR.git
synced 2026-10-01 04:13:33 +02:00
(v1.5.0.9006) major documentation update
This commit is contained in:
dr. M.S. (Matthijs) Berends committed
1 parent
e95218c0d1
commit
4eab095306
174 files changed
+1488
-1071
No files matched your search
@@ -6,7 +6,7 @@
|
||||
<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>
|
||||
<title>Apply EUCAST Rules — eucast_rules • AMR (for R)</title>
|
||||
|
||||
<!-- favicons -->
|
||||
<link rel="icon" type="image/png" sizes="16x16" href="../favicon-16x16.png">
|
||||
@@ -48,7 +48,7 @@
|
||||
<link href="../extra.css" rel="stylesheet">
|
||||
<script src="../extra.js"></script>
|
||||
|
||||
<meta property="og:title" content="Apply EUCAST rules — eucast_rules" />
|
||||
<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.
|
||||
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" />
|
||||
@@ -83,7 +83,7 @@ To improve the interpretation of the antibiogram before EUCAST rules are applied
|
||||
</button>
|
||||
<span class="navbar-brand">
|
||||
<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.5.0.9003</span>
|
||||
<span class="version label label-default" data-toggle="tooltip" data-placement="bottom" title="Latest development version">1.5.0.9006</span>
|
||||
</span>
|
||||
</div>
|
||||
|
||||
@@ -234,14 +234,14 @@ To improve the interpretation of the antibiogram before EUCAST rules are applied
|
||||
<div class="row">
|
||||
<div class="col-md-9 contents">
|
||||
<div class="page-header">
|
||||
<h1>Apply EUCAST rules</h1>
|
||||
<h1>Apply EUCAST Rules</h1>
|
||||
<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>
|
||||
<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 Details.</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>
|
||||
</div>
|
||||
|
||||
<pre class="usage"><span class='fu'>eucast_rules</span><span class='op'>(</span>
|
||||
@@ -295,7 +295,7 @@ To improve the interpretation of the antibiogram before EUCAST rules are applied
|
||||
</tr>
|
||||
<tr>
|
||||
<th>...</th>
|
||||
<td><p>column name of an antibiotic, please see section <em>Antibiotics</em> below</p></td>
|
||||
<td><p>column name of an antibiotic, see section <em>Antibiotics</em> below</p></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<th>ab</th>
|
||||
@@ -327,7 +327,7 @@ Leclercq et al. <strong>EUCAST expert rules in antimicrobial susceptibility test
|
||||
|
||||
<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.</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>.</p><h3 class='hasAnchor' id='arguments'><a class='anchor' href='#arguments'></a>'Other' rules</h3>
|
||||
<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>.</p><h3 class='hasAnchor' id='arguments'><a class='anchor' href='#arguments'></a>'Other' Rules</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>
|
||||
@@ -345,19 +345,19 @@ Leclercq et al. <strong>EUCAST expert rules in antimicrobial susceptibility test
|
||||
<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 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>
|
||||
<p>Amikacin (<code>AMK</code>, <a href='https://www.whocc.no/atc_ddd_index/?code=J01GB06&showdescription=no'>J01GB06</a>), amoxicillin (<code>AMX</code>, <a href='https://www.whocc.no/atc_ddd_index/?code=J01CA04&showdescription=no'>J01CA04</a>), amoxicillin/clavulanic acid (<code>AMC</code>, <a href='https://www.whocc.no/atc_ddd_index/?code=J01CR02&showdescription=no'>J01CR02</a>), ampicillin (<code>AMP</code>, <a href='https://www.whocc.no/atc_ddd_index/?code=J01CA01&showdescription=no'>J01CA01</a>), ampicillin/sulbactam (<code>SAM</code>, <a href='https://www.whocc.no/atc_ddd_index/?code=J01CR01&showdescription=no'>J01CR01</a>), avoparcin (<code>AVO</code>, no ATC code), azithromycin (<code>AZM</code>, <a href='https://www.whocc.no/atc_ddd_index/?code=J01FA10&showdescription=no'>J01FA10</a>), azlocillin (<code>AZL</code>, <a href='https://www.whocc.no/atc_ddd_index/?code=J01CA09&showdescription=no'>J01CA09</a>), aztreonam (<code>ATM</code>, <a href='https://www.whocc.no/atc_ddd_index/?code=J01DF01&showdescription=no'>J01DF01</a>), bacampicillin (<code>BAM</code>, <a href='https://www.whocc.no/atc_ddd_index/?code=J01CA06&showdescription=no'>J01CA06</a>), benzylpenicillin (<code>PEN</code>, <a href='https://www.whocc.no/atc_ddd_index/?code=J01CE01&showdescription=no'>J01CE01</a>), cadazolid (<code>CDZ</code>, <a href='https://www.whocc.no/atc_ddd_index/?code=J01DD09&showdescription=no'>J01DD09</a>), carbenicillin (<code>CRB</code>, <a href='https://www.whocc.no/atc_ddd_index/?code=J01CA03&showdescription=no'>J01CA03</a>), carindacillin (<code>CRN</code>, <a href='https://www.whocc.no/atc_ddd_index/?code=J01CA05&showdescription=no'>J01CA05</a>), cefacetrile (<code>CAC</code>, <a href='https://www.whocc.no/atc_ddd_index/?code=J01DB10&showdescription=no'>J01DB10</a>), cefaclor (<code>CEC</code>, <a href='https://www.whocc.no/atc_ddd_index/?code=J01DC04&showdescription=no'>J01DC04</a>), cefadroxil (<code>CFR</code>, <a href='https://www.whocc.no/atc_ddd_index/?code=J01DB05&showdescription=no'>J01DB05</a>), cefaloridine (<code>RID</code>, <a href='https://www.whocc.no/atc_ddd_index/?code=J01DB02&showdescription=no'>J01DB02</a>), cefamandole (<code>MAN</code>, <a href='https://www.whocc.no/atc_ddd_index/?code=J01DC03&showdescription=no'>J01DC03</a>), cefatrizine (<code>CTZ</code>, <a href='https://www.whocc.no/atc_ddd_index/?code=J01DB07&showdescription=no'>J01DB07</a>), cefazedone (<code>CZD</code>, <a href='https://www.whocc.no/atc_ddd_index/?code=J01DB06&showdescription=no'>J01DB06</a>), cefazolin (<code>CZO</code>, <a href='https://www.whocc.no/atc_ddd_index/?code=J01DB04&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&showdescription=no'>J01DD15</a>), cefditoren (<code>DIT</code>, <a href='https://www.whocc.no/atc_ddd_index/?code=J01DD16&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&showdescription=no'>J01DE01</a>), cefetamet (<code>CAT</code>, <a href='https://www.whocc.no/atc_ddd_index/?code=J01DD10&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&showdescription=no'>J01DD08</a>), cefmenoxime (<code>CMX</code>, <a href='https://www.whocc.no/atc_ddd_index/?code=J01DD05&showdescription=no'>J01DD05</a>), cefmetazole (<code>CMZ</code>, <a href='https://www.whocc.no/atc_ddd_index/?code=J01DC09&showdescription=no'>J01DC09</a>), cefodizime (<code>DIZ</code>, <a href='https://www.whocc.no/atc_ddd_index/?code=J01DD09&showdescription=no'>J01DD09</a>), cefonicid (<code>CID</code>, <a href='https://www.whocc.no/atc_ddd_index/?code=J01DC06&showdescription=no'>J01DC06</a>), cefoperazone (<code>CFP</code>, <a href='https://www.whocc.no/atc_ddd_index/?code=J01DD12&showdescription=no'>J01DD12</a>), cefoperazone/sulbactam (<code>CSL</code>, <a href='https://www.whocc.no/atc_ddd_index/?code=J01DD62&showdescription=no'>J01DD62</a>), ceforanide (<code>CND</code>, <a href='https://www.whocc.no/atc_ddd_index/?code=J01DC11&showdescription=no'>J01DC11</a>), cefotaxime (<code>CTX</code>, <a href='https://www.whocc.no/atc_ddd_index/?code=J01DD01&showdescription=no'>J01DD01</a>), cefotaxime/clavulanic acid (<code>CTC</code>, no ATC code), cefotaxime/sulbactam (<code>CTS</code>, no ATC code), cefotetan (<code>CTT</code>, <a href='https://www.whocc.no/atc_ddd_index/?code=J01DC05&showdescription=no'>J01DC05</a>), cefotiam (<code>CTF</code>, <a href='https://www.whocc.no/atc_ddd_index/?code=J01DC07&showdescription=no'>J01DC07</a>), cefotiam hexetil (<code>CHE</code>, no ATC code), cefoveciLine truncated
|
||||
<h2 class="hasAnchor" id="stable-lifecycle"><a class="anchor" href="#stable-lifecycle"></a>Stable lifecycle</h2>
|
||||
<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 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>
|
||||
<h2 class="hasAnchor" id="reference-data-publicly-available"><a class="anchor" href="#reference-data-publicly-available"></a>Reference Data Publicly Available</h2>
|
||||
|
||||
|
||||
|
||||
<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>
|
||||
<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>
|
||||
|
||||
|
||||
|
||||
|
||||
Reference in new issue
Block a user