mirror of https://github.com/msberends/AMR.git
238 lines
16 KiB
HTML
238 lines
16 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"><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."><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.2.2/bootstrap.min.css" rel="stylesheet"><script src="../deps/bootstrap-5.2.2/bootstrap.bundle.min.js"></script><link href="../deps/Fira_Code-0.4.5/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.jsdelivr.net/gh/afeld/bootstrap-toc@v1.0.1/dist/bootstrap-toc.min.js" integrity="sha256-4veVQbu7//Lk5TSmc7YV48MxtMy98e26cf5MrgZYnwo=" 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><!-- 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="Guess Antibiotic Column — guess_ab_col"><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"><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]>
|
||
<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>
|
||
|
||
<small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="">1.8.2.9100</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">
|
||
<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="../reference/AMR-options.html">
|
||
<span class="fa fa-gear"></span>
|
||
|
||
User- Or Team-specific Package Settings
|
||
</a>
|
||
<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 Taxonomy of a Microorganism
|
||
</a>
|
||
<a class="dropdown-item" href="../reference/ab_property.html">
|
||
<span class="fa fa-capsules"></span>
|
||
|
||
Get Properties of an Antibiotic Drug
|
||
</a>
|
||
<a class="dropdown-item" href="../reference/av_property.html">
|
||
<span class="fa fa-capsules"></span>
|
||
|
||
Get Properties of an Antiviral Drug
|
||
</a>
|
||
</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>Guess Antibiotic Column</h1>
|
||
<small class="dont-index">Source: <a href="https://github.com/msberends/AMR/blob/HEAD/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>x</dt>
|
||
<dd><p>a <a href="https://rdrr.io/r/base/data.frame.html" class="external-link">data.frame</a></p></dd>
|
||
|
||
|
||
<dt>search_string</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>verbose</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>only_sir_columns</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 (defaults to <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"><h2>On this page</h2>
|
||
</nav></aside></div>
|
||
|
||
|
||
<footer><div class="pkgdown-footer-left">
|
||
<p></p><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></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><a target="_blank" href="https://www.umcg.nl" class="external-link"><img src="https://github.com/msberends/AMR/raw/main/pkgdown/logos/logo_umcg.svg" style="max-width: 150px;"></a></p>
|
||
</div>
|
||
|
||
</footer></div>
|
||
|
||
|
||
|
||
|
||
|
||
</body></html>
|
||
|