mirror of https://github.com/msberends/AMR.git
394 lines
19 KiB
HTML
394 lines
19 KiB
HTML
<!-- 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>Determine Bug-Drug Combinations — bug_drug_combinations • 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" />
|
|
|
|
<!-- jquery -->
|
|
<script src="https://cdnjs.cloudflare.com/ajax/libs/jquery/3.4.1/jquery.min.js" integrity="sha256-CSXorXvZcTkaix6Yvo6HppcZGetbYMGWSFlBw8HfCJo=" crossorigin="anonymous"></script>
|
|
<!-- Bootstrap -->
|
|
<link href="https://cdnjs.cloudflare.com/ajax/libs/bootswatch/3.4.0/flatly/bootstrap.min.css" rel="stylesheet" crossorigin="anonymous" />
|
|
|
|
|
|
<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>
|
|
|
|
<!-- bootstrap-toc -->
|
|
<link rel="stylesheet" href="../bootstrap-toc.css">
|
|
<script src="../bootstrap-toc.js"></script>
|
|
|
|
<!-- Font Awesome icons -->
|
|
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.12.1/css/all.min.css" integrity="sha256-mmgLkCYLUQbXn0B1SRqzHar6dCnv9oZFPEC1g1cwlkk=" crossorigin="anonymous" />
|
|
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.12.1/css/v4-shims.min.css" integrity="sha256-wZjR52fzng1pJHwx4aV2AO3yyTOXrcDW7jBpJtTwVxw=" crossorigin="anonymous" />
|
|
|
|
<!-- clipboard.js -->
|
|
<script src="https://cdnjs.cloudflare.com/ajax/libs/clipboard.js/2.0.6/clipboard.min.js" integrity="sha256-inc5kl9MA1hkeYUt+EC3BhlIgyp/2jDIyBLS6k3UxPI=" crossorigin="anonymous"></script>
|
|
|
|
<!-- headroom.js -->
|
|
<script src="https://cdnjs.cloudflare.com/ajax/libs/headroom/0.11.0/headroom.min.js" integrity="sha256-AsUX4SJE1+yuDu5+mAVzJbuYNPHj/WroHuZ8Ir/CkE0=" crossorigin="anonymous"></script>
|
|
<script src="https://cdnjs.cloudflare.com/ajax/libs/headroom/0.11.0/jQuery.headroom.min.js" integrity="sha256-ZX/yNShbjqsohH1k95liqY9Gd8uOiE1S4vZc+9KQ1K4=" crossorigin="anonymous"></script>
|
|
|
|
<!-- pkgdown -->
|
|
<link href="../pkgdown.css" rel="stylesheet">
|
|
<script src="../pkgdown.js"></script>
|
|
|
|
|
|
|
|
<link href="../extra.css" rel="stylesheet">
|
|
<script src="../extra.js"></script>
|
|
|
|
<meta property="og:title" content="Determine Bug-Drug Combinations — bug_drug_combinations" />
|
|
<meta property="og:description" content="Determine antimicrobial resistance (AMR) of all bug-drug combinations in your data set where at least 30 (default) isolates are available per species. Use format() on the result to prettify it to a publishable/printable format, see Examples." />
|
|
<meta property="og:image" content="https://msberends.github.io/AMR/logo.png" />
|
|
<meta name="twitter:card" content="summary_large_image" />
|
|
<meta name="twitter:creator" content="@msberends" />
|
|
<meta name="twitter:site" content="@univgroningen" />
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<!-- mathjax -->
|
|
<script src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/MathJax.js" integrity="sha256-nvJJv9wWKEm88qvoQl9ekL2J+k/RWIsaSScxxlsrv8k=" crossorigin="anonymous"></script>
|
|
<script src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/config/TeX-AMS-MML_HTMLorMML.js" integrity="sha256-84DKXVJXs0/F8OTMzX4UR909+jtl4G7SPypPavF+GfA=" crossorigin="anonymous"></script>
|
|
|
|
<!--[if lt IE 9]>
|
|
<script src="https://oss.maxcdn.com/html5shiv/3.7.3/html5shiv.min.js"></script>
|
|
<script src="https://oss.maxcdn.com/respond/1.4.2/respond.min.js"></script>
|
|
<![endif]-->
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</head>
|
|
|
|
<body data-spy="scroll" data-target="#toc">
|
|
|
|
|
|
<div class="container template-reference-topic">
|
|
<header>
|
|
<div class="navbar navbar-default navbar-fixed-top" role="navigation">
|
|
<div class="container">
|
|
<div class="navbar-header">
|
|
<button type="button" class="navbar-toggle collapsed" data-toggle="collapse" data-target="#navbar" aria-expanded="false">
|
|
<span class="sr-only">Toggle navigation</span>
|
|
<span class="icon-bar"></span>
|
|
<span class="icon-bar"></span>
|
|
<span class="icon-bar"></span>
|
|
</button>
|
|
<span class="navbar-brand">
|
|
<a class="navbar-link" href="../index.html">AMR (for R)</a>
|
|
<span class="version label label-default" data-toggle="tooltip" data-placement="bottom" title="Latest development version">1.7.1.9030</span>
|
|
</span>
|
|
</div>
|
|
|
|
<div id="navbar" class="navbar-collapse collapse">
|
|
<ul class="nav navbar-nav">
|
|
<li>
|
|
<a href="../index.html">
|
|
<span class="fa fa-home"></span>
|
|
|
|
Home
|
|
</a>
|
|
</li>
|
|
<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
|
|
|
|
<span class="caret"></span>
|
|
</a>
|
|
<ul class="dropdown-menu" role="menu">
|
|
<li>
|
|
<a href="../articles/AMR.html">
|
|
<span class="fa fa-directions"></span>
|
|
|
|
Conduct AMR analysis
|
|
</a>
|
|
</li>
|
|
<li>
|
|
<a href="../articles/resistance_predict.html">
|
|
<span class="fa fa-dice"></span>
|
|
|
|
Predict antimicrobial resistance
|
|
</a>
|
|
</li>
|
|
<li>
|
|
<a href="../articles/datasets.html">
|
|
<span class="fa fa-database"></span>
|
|
|
|
Data sets for download / own use
|
|
</a>
|
|
</li>
|
|
<li>
|
|
<a href="../articles/PCA.html">
|
|
<span class="fa fa-compress"></span>
|
|
|
|
Conduct principal component analysis for AMR
|
|
</a>
|
|
</li>
|
|
<li>
|
|
<a href="../articles/MDR.html">
|
|
<span class="fa fa-skull-crossbones"></span>
|
|
|
|
Determine multi-drug resistance (MDR)
|
|
</a>
|
|
</li>
|
|
<li>
|
|
<a href="../articles/WHONET.html">
|
|
<span class="fa fa-globe-americas"></span>
|
|
|
|
Work with WHONET data
|
|
</a>
|
|
</li>
|
|
<li>
|
|
<a href="../articles/SPSS.html">
|
|
<span class="fa fa-file-upload"></span>
|
|
|
|
Import data from SPSS/SAS/Stata
|
|
</a>
|
|
</li>
|
|
<li>
|
|
<a href="../articles/EUCAST.html">
|
|
<span class="fa fa-exchange-alt"></span>
|
|
|
|
Apply EUCAST rules
|
|
</a>
|
|
</li>
|
|
<li>
|
|
<a href="../reference/mo_property.html">
|
|
<span class="fa fa-bug"></span>
|
|
|
|
Get properties of a microorganism
|
|
</a>
|
|
</li>
|
|
<li>
|
|
<a href="../reference/ab_property.html">
|
|
<span class="fa fa-capsules"></span>
|
|
|
|
Get properties of an antibiotic
|
|
</a>
|
|
</li>
|
|
<li>
|
|
<a href="../articles/benchmarks.html">
|
|
<span class="fa fa-shipping-fast"></span>
|
|
|
|
Other: benchmarks
|
|
</a>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<a href="../reference/index.html">
|
|
<span class="fa fa-book-open"></span>
|
|
|
|
Manual
|
|
</a>
|
|
</li>
|
|
<li>
|
|
<a href="../authors.html">
|
|
<span class="fa fa-users"></span>
|
|
|
|
Authors
|
|
</a>
|
|
</li>
|
|
<li>
|
|
<a href="../news/index.html">
|
|
<span class="far fa-newspaper"></span>
|
|
|
|
Changelog
|
|
</a>
|
|
</li>
|
|
</ul>
|
|
<ul class="nav navbar-nav navbar-right">
|
|
<li>
|
|
<a href="https://github.com/msberends/AMR">
|
|
<span class="fab fa-github"></span>
|
|
|
|
Source Code
|
|
</a>
|
|
</li>
|
|
</ul>
|
|
|
|
</div><!--/.nav-collapse -->
|
|
</div><!--/.container -->
|
|
</div><!--/.navbar -->
|
|
|
|
|
|
|
|
</header>
|
|
|
|
<div class="row">
|
|
<div class="col-md-9 contents">
|
|
<div class="page-header">
|
|
<h1>Determine Bug-Drug Combinations</h1>
|
|
<small class="dont-index">Source: <a href='https://github.com/msberends/AMR/blob/main/R/bug_drug_combinations.R'><code>R/bug_drug_combinations.R</code></a></small>
|
|
<div class="hidden name"><code>bug_drug_combinations.Rd</code></div>
|
|
</div>
|
|
|
|
<div class="ref-description">
|
|
<p>Determine antimicrobial resistance (AMR) of all bug-drug combinations in your data set where at least 30 (default) isolates are available per species. Use <code><a href='https://rdrr.io/r/base/format.html'>format()</a></code> on the result to prettify it to a publishable/printable format, see <em>Examples</em>.</p>
|
|
</div>
|
|
|
|
<div class="ref-usage sourceCode"><pre class='sourceCode r'><code><span class='fu'>bug_drug_combinations</span><span class='op'>(</span><span class='va'>x</span>, col_mo <span class='op'>=</span> <span class='cn'>NULL</span>, FUN <span class='op'>=</span> <span class='va'>mo_shortname</span>, <span class='va'>...</span><span class='op'>)</span>
|
|
|
|
<span class='co'># S3 method for bug_drug_combinations</span>
|
|
<span class='fu'><a href='https://rdrr.io/r/base/format.html'>format</a></span><span class='op'>(</span>
|
|
<span class='va'>x</span>,
|
|
translate_ab <span class='op'>=</span> <span class='st'>"name (ab, atc)"</span>,
|
|
language <span class='op'>=</span> <span class='fu'><a href='translate.html'>get_locale</a></span><span class='op'>(</span><span class='op'>)</span>,
|
|
minimum <span class='op'>=</span> <span class='fl'>30</span>,
|
|
combine_SI <span class='op'>=</span> <span class='cn'>TRUE</span>,
|
|
combine_IR <span class='op'>=</span> <span class='cn'>FALSE</span>,
|
|
add_ab_group <span class='op'>=</span> <span class='cn'>TRUE</span>,
|
|
remove_intrinsic_resistant <span class='op'>=</span> <span class='cn'>FALSE</span>,
|
|
decimal.mark <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'>"OutDec"</span><span class='op'>)</span>,
|
|
big.mark <span class='op'>=</span> <span class='fu'><a href='https://rdrr.io/r/base/ifelse.html'>ifelse</a></span><span class='op'>(</span><span class='va'>decimal.mark</span> <span class='op'>==</span> <span class='st'>","</span>, <span class='st'>"."</span>, <span class='st'>","</span><span class='op'>)</span>,
|
|
<span class='va'>...</span>
|
|
<span class='op'>)</span></code></pre></div>
|
|
|
|
<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>x</th>
|
|
<td><p>data with antibiotic columns, such as <code>amox</code>, <code>AMX</code> and <code>AMC</code></p></td>
|
|
</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>
|
|
</tr>
|
|
<tr>
|
|
<th>FUN</th>
|
|
<td><p>the function to call on the <code>mo</code> column to transform the microorganism codes, defaults to <code><a href='mo_property.html'>mo_shortname()</a></code></p></td>
|
|
</tr>
|
|
<tr>
|
|
<th>...</th>
|
|
<td><p>arguments passed on to <code>FUN</code></p></td>
|
|
</tr>
|
|
<tr>
|
|
<th>translate_ab</th>
|
|
<td><p>a <a href='https://rdrr.io/r/base/character.html'>character</a> of length 1 containing column names of the <a href='antibiotics.html'>antibiotics</a> data set</p></td>
|
|
</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>
|
|
</tr>
|
|
<tr>
|
|
<th>minimum</th>
|
|
<td><p>the minimum allowed number of available (tested) isolates. Any isolate count lower than <code>minimum</code> will return <code>NA</code> with a warning. The default number of <code>30</code> isolates is advised by the Clinical and Laboratory Standards Institute (CLSI) as best practice, see <em>Source</em>.</p></td>
|
|
</tr>
|
|
<tr>
|
|
<th>combine_SI</th>
|
|
<td><p>a <a href='https://rdrr.io/r/base/logical.html'>logical</a> 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 argument <code>combine_IR</code>, but this now follows the redefinition by EUCAST about the interpretation of I (increased exposure) in 2019, see section 'Interpretation of S, I and R' below. Default is <code>TRUE</code>.</p></td>
|
|
</tr>
|
|
<tr>
|
|
<th>combine_IR</th>
|
|
<td><p>a <a href='https://rdrr.io/r/base/logical.html'>logical</a> to indicate whether values R and I should be summed</p></td>
|
|
</tr>
|
|
<tr>
|
|
<th>add_ab_group</th>
|
|
<td><p>a <a href='https://rdrr.io/r/base/logical.html'>logical</a> to indicate where the group of the antimicrobials must be included as a first column</p></td>
|
|
</tr>
|
|
<tr>
|
|
<th>remove_intrinsic_resistant</th>
|
|
<td><p><a href='https://rdrr.io/r/base/logical.html'>logical</a> to indicate that rows and columns with 100% resistance for all tested antimicrobials must be removed from the table</p></td>
|
|
</tr>
|
|
<tr>
|
|
<th>decimal.mark</th>
|
|
<td><p>the character to be used to indicate the numeric
|
|
decimal point.</p></td>
|
|
</tr>
|
|
<tr>
|
|
<th>big.mark</th>
|
|
<td><p>character; if not empty used as mark between every
|
|
<code>big.interval</code> decimals <em>before</em> (hence <code>big</code>) the
|
|
decimal point.</p></td>
|
|
</tr>
|
|
</table>
|
|
|
|
<h2 class="hasAnchor" id="source"><a class="anchor" href="#source"></a>Source</h2>
|
|
|
|
<p><strong>M39 Analysis and Presentation of Cumulative Antimicrobial Susceptibility Test Data, 4th Edition</strong>, 2014, <em>Clinical and Laboratory Standards Institute (CLSI)</em>. <a href='https://clsi.org/standards/products/microbiology/documents/m39/'>https://clsi.org/standards/products/microbiology/documents/m39/</a>.</p>
|
|
<h2 class="hasAnchor" id="value"><a class="anchor" href="#value"></a>Value</h2>
|
|
|
|
<p>The function <code>bug_drug_combinations()</code> returns a <a href='https://rdrr.io/r/base/data.frame.html'>data.frame</a> with columns "mo", "ab", "S", "I", "R" and "total".</p>
|
|
<h2 class="hasAnchor" id="details"><a class="anchor" href="#details"></a>Details</h2>
|
|
|
|
<p>The function <code><a href='https://rdrr.io/r/base/format.html'>format()</a></code> calculates the resistance per bug-drug combination. Use <code>combine_IR = FALSE</code> (default) to test R vs. S+I and <code>combine_IR = TRUE</code> to test R+I vs. S.</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 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="read-more-on-our-website-"><a class="anchor" href="#read-more-on-our-website-"></a>Read more on Our Website!</h2>
|
|
|
|
|
|
|
|
<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>.</p>
|
|
|
|
<h2 class="hasAnchor" id="examples"><a class="anchor" href="#examples"></a>Examples</h2>
|
|
<div class="ref-examples sourceCode"><pre class='sourceCode r'><code><span class='co'># \donttest{</span>
|
|
<span class='va'>x</span> <span class='op'><-</span> <span class='fu'>bug_drug_combinations</span><span class='op'>(</span><span class='va'>example_isolates</span><span class='op'>)</span>
|
|
<span class='va'>x</span>
|
|
<span class='fu'><a href='https://rdrr.io/r/base/format.html'>format</a></span><span class='op'>(</span><span class='va'>x</span>, translate_ab <span class='op'>=</span> <span class='st'>"name (atc)"</span><span class='op'>)</span>
|
|
|
|
<span class='co'># Use FUN to change to transformation of microorganism codes</span>
|
|
<span class='fu'>bug_drug_combinations</span><span class='op'>(</span><span class='va'>example_isolates</span>,
|
|
FUN <span class='op'>=</span> <span class='va'>mo_gramstain</span><span class='op'>)</span>
|
|
|
|
<span class='fu'>bug_drug_combinations</span><span class='op'>(</span><span class='va'>example_isolates</span>,
|
|
FUN <span class='op'>=</span> <span class='kw'>function</span><span class='op'>(</span><span class='va'>x</span><span class='op'>)</span> <span class='fu'><a href='https://rdrr.io/r/base/ifelse.html'>ifelse</a></span><span class='op'>(</span><span class='va'>x</span> <span class='op'>==</span> <span class='fu'><a href='as.mo.html'>as.mo</a></span><span class='op'>(</span><span class='st'>"E. coli"</span><span class='op'>)</span>,
|
|
<span class='st'>"E. coli"</span>,
|
|
<span class='st'>"Others"</span><span class='op'>)</span><span class='op'>)</span>
|
|
<span class='co'># }</span>
|
|
</code></pre></div>
|
|
</div>
|
|
<div class="col-md-3 hidden-xs hidden-sm" id="pkgdown-sidebar">
|
|
<nav id="toc" data-toggle="toc" class="sticky-top">
|
|
<h2 data-toc-skip>Contents</h2>
|
|
</nav>
|
|
</div>
|
|
</div>
|
|
|
|
|
|
<footer>
|
|
<div class="copyright">
|
|
<p><p>Developed by <a href="https://www.rug.nl/staff/m.s.berends/" class="external-link">Matthijs S. Berends</a>, <a href="https://www.rug.nl/staff/c.f.luz/" class="external-link">Christian F. Luz</a>, <a href="https://www.rug.nl/staff/a.w.friedrich/" class="external-link">Alexander W. Friedrich</a>, <a href="https://www.rug.nl/staff/b.sinha/" class="external-link">Bhanu N. M. Sinha</a>, <a href="https://www.rug.nl/staff/c.j.albers/" class="external-link">Casper J. Albers</a>, <a href="https://www.rug.nl/staff/c.glasner/" class="external-link">Corinna Glasner</a>.</p></p>
|
|
</div>
|
|
|
|
<div class="pkgdown">
|
|
<p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 1.6.1.9001.</p></p>
|
|
</div>
|
|
|
|
</footer>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</body>
|
|
</html>
|
|
|
|
|