mirror of
https://github.com/msberends/AMR.git
synced 2024-12-25 19:26:13 +01:00
149 lines
14 KiB
HTML
149 lines
14 KiB
HTML
<!DOCTYPE html>
|
||
<!-- 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"><title>Guess Antibiotic Column — guess_ab_col • 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.3.1/bootstrap.min.css" rel="stylesheet"><script src="../deps/bootstrap-5.3.1/bootstrap.bundle.min.js"></script><link href="../deps/Lato-0.4.9/font.css" rel="stylesheet"><link href="../deps/Fira_Code-0.4.9/font.css" rel="stylesheet"><link href="../deps/font-awesome-6.5.2/css/all.min.css" rel="stylesheet"><link href="../deps/font-awesome-6.5.2/css/v4-shims.min.css" rel="stylesheet"><script src="../deps/headroom-0.11.0/headroom.min.js"></script><script src="../deps/headroom-0.11.0/jQuery.headroom.min.js"></script><script src="../deps/bootstrap-toc-1.0.1/bootstrap-toc.min.js"></script><script src="../deps/clipboard.js-2.0.11/clipboard.min.js"></script><script src="../deps/search-1.0.0/autocomplete.jquery.min.js"></script><script src="../deps/search-1.0.0/fuse.min.js"></script><script src="../deps/search-1.0.0/mark.min.js"></script><!-- pkgdown --><script src="../pkgdown.js"></script><link href="../extra.css" rel="stylesheet"><script src="../extra.js"></script><meta property="og:title" content="Guess Antibiotic Column — guess_ab_col"><meta name="description" content="This tries to find a column name in a data set based on information from the antibiotics data set. Also supports WHONET abbreviations."><meta property="og:description" content="This tries to find a column name in a data set based on information from the antibiotics data set. Also supports WHONET abbreviations."><meta property="og:image" content="https://msberends.github.io/AMR/logo.svg"></head><body>
|
||
<a href="#main" class="visually-hidden-focusable">Skip to contents</a>
|
||
|
||
|
||
<nav class="navbar navbar-expand-lg fixed-top bg-primary" data-bs-theme="dark" aria-label="Site navigation"><div class="container">
|
||
|
||
<a class="navbar-brand me-2" href="../index.html">AMR (for R)</a>
|
||
|
||
<small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="">2.1.1.9122</small>
|
||
|
||
|
||
<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 dropdown">
|
||
<button class="nav-link dropdown-toggle" type="button" id="dropdown-how-to" data-bs-toggle="dropdown" aria-expanded="false" aria-haspopup="true"><span class="fa fa-question-circle"></span> How to</button>
|
||
<ul class="dropdown-menu" aria-labelledby="dropdown-how-to"><li><a class="dropdown-item" href="../articles/AMR.html"><span class="fa fa-directions"></span> Conduct AMR Analysis</a></li>
|
||
<li><a class="dropdown-item" href="../reference/antibiogram.html"><span class="fa fa-file-prescription"></span> Generate Antibiogram (Trad./Syndromic/WISCA)</a></li>
|
||
<li><a class="dropdown-item" href="../articles/resistance_predict.html"><span class="fa fa-dice"></span> Predict Antimicrobial Resistance</a></li>
|
||
<li><a class="dropdown-item" href="../articles/datasets.html"><span class="fa fa-database"></span> Download Data Sets for Own Use</a></li>
|
||
<li><a class="dropdown-item" href="../articles/AMR_with_tidymodels.html"><span class="fa fa-square-root-variable"></span> Use AMR for Predictive Modelling (tidymodels)</a></li>
|
||
<li><a class="dropdown-item" href="../reference/AMR-options.html"><span class="fa fa-gear"></span> Set User- Or Team-specific Package Settings</a></li>
|
||
<li><a class="dropdown-item" href="../articles/PCA.html"><span class="fa fa-compress"></span> Conduct Principal Component Analysis for AMR</a></li>
|
||
<li><a class="dropdown-item" href="../articles/MDR.html"><span class="fa fa-skull-crossbones"></span> Determine Multi-Drug Resistance (MDR)</a></li>
|
||
<li><a class="dropdown-item" href="../articles/WHONET.html"><span class="fa fa-globe-americas"></span> Work with WHONET Data</a></li>
|
||
<li><a class="dropdown-item" href="../articles/EUCAST.html"><span class="fa fa-exchange-alt"></span> Apply Eucast Rules</a></li>
|
||
<li><a class="dropdown-item" href="../reference/mo_property.html"><span class="fa fa-bug"></span> Get Taxonomy of a Microorganism</a></li>
|
||
<li><a class="dropdown-item" href="../reference/ab_property.html"><span class="fa fa-capsules"></span> Get Properties of an Antibiotic Drug</a></li>
|
||
<li><a class="dropdown-item" href="../reference/av_property.html"><span class="fa fa-capsules"></span> Get Properties of an Antiviral Drug</a></li>
|
||
</ul></li>
|
||
<li class="nav-item"><a class="nav-link" href="../articles/AMR_for_Python.html"><span class="fa fab fa-python"></span> AMR for Python</a></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>
|
||
</ul><ul class="navbar-nav"><li class="nav-item"><a class="nav-link" href="../news/index.html"><span class="fa far fa-newspaper"></span> Changelog</a></li>
|
||
<li class="nav-item"><a class="external-link nav-link" href="https://github.com/msberends/AMR"><span class="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>Guess Antibiotic Column</h1>
|
||
<small class="dont-index">Source: <a href="https://github.com/msberends/AMR/blob/main/R/guess_ab_col.R" class="external-link"><code>R/guess_ab_col.R</code></a></small>
|
||
<div class="d-none name"><code>guess_ab_col.Rd</code></div>
|
||
</div>
|
||
|
||
<div class="ref-description section level2">
|
||
<p>This tries to find a column name in a data set based on information from the <a href="antibiotics.html">antibiotics</a> data set. Also supports WHONET abbreviations.</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">guess_ab_col</span><span class="op">(</span></span>
|
||
<span> x <span class="op">=</span> <span class="cn">NULL</span>,</span>
|
||
<span> search_string <span class="op">=</span> <span class="cn">NULL</span>,</span>
|
||
<span> verbose <span class="op">=</span> <span class="cn">FALSE</span>,</span>
|
||
<span> only_sir_columns <span class="op">=</span> <span class="cn">FALSE</span></span>
|
||
<span><span class="op">)</span></span></code></pre></div>
|
||
</div>
|
||
|
||
<div class="section level2">
|
||
<h2 id="arguments">Arguments<a class="anchor" aria-label="anchor" href="#arguments"></a></h2>
|
||
|
||
|
||
<dl><dt id="arg-x">x<a class="anchor" aria-label="anchor" href="#arg-x"></a></dt>
|
||
<dd><p>a <a href="https://rdrr.io/r/base/data.frame.html" class="external-link">data.frame</a></p></dd>
|
||
|
||
|
||
<dt id="arg-search-string">search_string<a class="anchor" aria-label="anchor" href="#arg-search-string"></a></dt>
|
||
<dd><p>a text to search <code>x</code> for, will be checked with <code><a href="as.ab.html">as.ab()</a></code> if this value is not a column in <code>x</code></p></dd>
|
||
|
||
|
||
<dt id="arg-verbose">verbose<a class="anchor" aria-label="anchor" href="#arg-verbose"></a></dt>
|
||
<dd><p>a <a href="https://rdrr.io/r/base/logical.html" class="external-link">logical</a> to indicate whether additional info should be printed</p></dd>
|
||
|
||
|
||
<dt id="arg-only-sir-columns">only_sir_columns<a class="anchor" aria-label="anchor" href="#arg-only-sir-columns"></a></dt>
|
||
<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>sir</code> (see <code><a href="as.sir.html">as.sir()</a></code>) on beforehand (default is <code>FALSE</code>)</p></dd>
|
||
|
||
</dl></div>
|
||
<div class="section level2">
|
||
<h2 id="value">Value<a class="anchor" aria-label="anchor" href="#value"></a></h2>
|
||
<p>A column name of <code>x</code>, or <code>NULL</code> when no result is found.</p>
|
||
</div>
|
||
<div class="section level2">
|
||
<h2 id="details">Details<a class="anchor" aria-label="anchor" href="#details"></a></h2>
|
||
<p>You can look for an antibiotic (trade) name or abbreviation and it will search <code>x</code> and the <a href="antibiotics.html">antibiotics</a> data set for any column containing a name or code of that antibiotic.</p>
|
||
</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="va">df</span> <span class="op"><-</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> amox <span class="op">=</span> <span class="st">"S"</span>,</span></span>
|
||
<span class="r-in"><span> tetr <span class="op">=</span> <span class="st">"R"</span></span></span>
|
||
<span class="r-in"><span><span class="op">)</span></span></span>
|
||
<span class="r-in"><span></span></span>
|
||
<span class="r-in"><span><span class="fu">guess_ab_col</span><span class="op">(</span><span class="va">df</span>, <span class="st">"amoxicillin"</span><span class="op">)</span></span></span>
|
||
<span class="r-out co"><span class="r-pr">#></span> [1] "amox"</span>
|
||
<span class="r-in"><span><span class="fu">guess_ab_col</span><span class="op">(</span><span class="va">df</span>, <span class="st">"J01AA07"</span><span class="op">)</span> <span class="co"># ATC code of tetracycline</span></span></span>
|
||
<span class="r-out co"><span class="r-pr">#></span> [1] "tetr"</span>
|
||
<span class="r-in"><span></span></span>
|
||
<span class="r-in"><span><span class="fu">guess_ab_col</span><span class="op">(</span><span class="va">df</span>, <span class="st">"J01AA07"</span>, verbose <span class="op">=</span> <span class="cn">TRUE</span><span class="op">)</span></span></span>
|
||
<span class="r-msg co"><span class="r-pr">#></span> Auto-guessing columns suitable for analysis</span>
|
||
<span class="r-msg co"><span class="r-pr">#></span> ...</span>
|
||
<span class="r-msg co"><span class="r-pr">#></span> OK.</span>
|
||
<span class="r-msg co"><span class="r-pr">#></span> ℹ Using column 'amox' as input for AMX (amoxicillin).</span>
|
||
<span class="r-msg co"><span class="r-pr">#></span> ℹ Using column 'tetr' as input for TCY (tetracycline).</span>
|
||
<span class="r-msg co"><span class="r-pr">#></span> ℹ Using column 'tetr' as input for J01AA07 (tetracycline).</span>
|
||
<span class="r-out co"><span class="r-pr">#></span> [1] "tetr"</span>
|
||
<span class="r-in"><span><span class="co"># NOTE: Using column 'tetr' as input for J01AA07 (tetracycline).</span></span></span>
|
||
<span class="r-in"><span></span></span>
|
||
<span class="r-in"><span><span class="co"># WHONET codes</span></span></span>
|
||
<span class="r-in"><span><span class="va">df</span> <span class="op"><-</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> AMP_ND10 <span class="op">=</span> <span class="st">"R"</span>,</span></span>
|
||
<span class="r-in"><span> AMC_ED20 <span class="op">=</span> <span class="st">"S"</span></span></span>
|
||
<span class="r-in"><span><span class="op">)</span></span></span>
|
||
<span class="r-in"><span><span class="fu">guess_ab_col</span><span class="op">(</span><span class="va">df</span>, <span class="st">"ampicillin"</span><span class="op">)</span></span></span>
|
||
<span class="r-out co"><span class="r-pr">#></span> [1] "AMP_ND10"</span>
|
||
<span class="r-in"><span><span class="fu">guess_ab_col</span><span class="op">(</span><span class="va">df</span>, <span class="st">"J01CR02"</span><span class="op">)</span></span></span>
|
||
<span class="r-out co"><span class="r-pr">#></span> [1] "AMC_ED20"</span>
|
||
<span class="r-in"><span><span class="fu">guess_ab_col</span><span class="op">(</span><span class="va">df</span>, <span class="fu"><a href="as.ab.html">as.ab</a></span><span class="op">(</span><span class="st">"augmentin"</span><span class="op">)</span><span class="op">)</span></span></span>
|
||
<span class="r-out co"><span class="r-pr">#></span> [1] "AMC_ED20"</span>
|
||
</code></pre></div>
|
||
</div>
|
||
</main><aside class="col-md-3"><nav id="toc" aria-label="Table of contents"><h2>On this page</h2>
|
||
</nav></aside></div>
|
||
|
||
|
||
<footer><div class="pkgdown-footer-left">
|
||
<p><code>AMR</code> (for R). Free and open-source, licenced under the <a target="_blank" href="https://github.com/msberends/AMR/blob/main/LICENSE" class="external-link">GNU General Public License version 2.0 (GPL-2)</a>.<br>Developed at the <a target="_blank" href="https://www.rug.nl" class="external-link">University of Groningen</a> and <a target="_blank" href="https://www.umcg.nl" class="external-link">University Medical Center Groningen</a> in The Netherlands.</p>
|
||
</div>
|
||
|
||
<div class="pkgdown-footer-right">
|
||
<p><a target="_blank" href="https://www.rug.nl" class="external-link"><img src="https://github.com/msberends/AMR/raw/main/pkgdown/assets/logo_rug.svg" style="max-width: 150px;"></a><a target="_blank" href="https://www.umcg.nl" class="external-link"><img src="https://github.com/msberends/AMR/raw/main/pkgdown/assets/logo_umcg.svg" style="max-width: 150px;"></a></p>
|
||
</div>
|
||
|
||
</footer></div>
|
||
|
||
|
||
|
||
|
||
|
||
</body></html>
|
||
|