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

357 lines
29 KiB
HTML
Raw Normal View History

2022-12-27 16:14:41 +01:00
<!DOCTYPE html>
2024-02-13 13:53:34 +01: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="With add_custom_microorganisms() you can add your own custom microorganisms, such the non-taxonomic outcome of laboratory analysis."><title>Add Custom Microorganisms — add_custom_microorganisms • 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/Fira_Code-0.4.8/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="Add Custom Microorganisms — add_custom_microorganisms"><meta property="og:description" content="With add_custom_microorganisms() you can add your own custom microorganisms, such the non-taxonomic outcome of laboratory analysis."><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/
2022-12-27 16:14:41 +01: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>
2024-02-24 19:32:41 +01:00
<small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="">2.1.1.9009</small>
2022-12-27 16:14:41 +01: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">
2023-05-24 16:03:18 +02:00
<ul class="navbar-nav me-auto"><li class="nav-item dropdown">
2022-12-27 16:14:41 +01:00
<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>
2023-01-23 20:14:37 +01:00
Conduct AMR Analysis
2022-12-27 16:14:41 +01:00
</a>
2023-02-08 17:01:47 +01:00
<a class="dropdown-item" href="../reference/antibiogram.html">
<span class="fa fa-file-prescription"></span>
Generate Antibiogram (Trad./Syndromic/WISCA)
</a>
2022-12-27 16:14:41 +01:00
<a class="dropdown-item" href="../articles/resistance_predict.html">
<span class="fa fa-dice"></span>
2023-01-23 20:14:37 +01:00
Predict Antimicrobial Resistance
2022-12-27 16:14:41 +01:00
</a>
<a class="dropdown-item" href="../articles/datasets.html">
<span class="fa fa-database"></span>
2023-02-26 21:34:01 +01:00
Download Data Sets for Own Use
</a>
<a class="dropdown-item" href="../reference/AMR-options.html">
<span class="fa fa-gear"></span>
Set User- Or Team-specific Package Settings
2022-12-27 16:14:41 +01:00
</a>
<a class="dropdown-item" href="../articles/PCA.html">
<span class="fa fa-compress"></span>
2023-01-23 20:14:37 +01:00
Conduct Principal Component Analysis for AMR
2022-12-27 16:14:41 +01:00
</a>
<a class="dropdown-item" href="../articles/MDR.html">
<span class="fa fa-skull-crossbones"></span>
2023-01-23 20:14:37 +01:00
Determine Multi-Drug Resistance (MDR)
2022-12-27 16:14:41 +01:00
</a>
<a class="dropdown-item" href="../articles/WHONET.html">
<span class="fa fa-globe-americas"></span>
2023-01-23 20:14:37 +01:00
Work with WHONET Data
2022-12-27 16:14:41 +01:00
</a>
<a class="dropdown-item" href="../articles/EUCAST.html">
<span class="fa fa-exchange-alt"></span>
2023-01-23 20:14:37 +01:00
Apply Eucast Rules
2022-12-27 16:14:41 +01:00
</a>
<a class="dropdown-item" href="../reference/mo_property.html">
<span class="fa fa-bug"></span>
2023-01-23 20:14:37 +01:00
Get Taxonomy of a Microorganism
2022-12-27 16:14:41 +01:00
</a>
<a class="dropdown-item" href="../reference/ab_property.html">
<span class="fa fa-capsules"></span>
2023-01-23 20:14:37 +01:00
Get Properties of an Antibiotic Drug
2022-12-27 16:14:41 +01:00
</a>
<a class="dropdown-item" href="../reference/av_property.html">
<span class="fa fa-capsules"></span>
2023-01-23 20:14:37 +01:00
Get Properties of an Antiviral Drug
2022-12-27 16:14:41 +01:00
</a>
</div>
</li>
2023-05-24 16:03:18 +02:00
<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--with-other-pkgs">
2023-05-27 10:53:23 +02:00
<span class="fa fa-layer-group"></span>
2023-05-24 16:03:18 +02:00
With other pkgs
</a>
<div class="dropdown-menu" aria-labelledby="dropdown--with-other-pkgs">
<a class="dropdown-item" href="../articles/other_pkg.html">
2023-05-27 10:53:23 +02:00
<span class="fa fa-layer-group"></span>
2023-05-24 16:03:18 +02:00
AMR &amp; dplyr/tidyverse
</a>
<a class="dropdown-item" href="../articles/other_pkg.html">
2023-05-27 10:53:23 +02:00
<span class="fa fa-layer-group"></span>
2023-05-24 16:03:18 +02:00
AMR &amp; data.table
</a>
<a class="dropdown-item" href="../articles/other_pkg.html">
2023-05-27 10:53:23 +02:00
<span class="fa fa-layer-group"></span>
2023-05-24 16:03:18 +02:00
AMR &amp; tidymodels
</a>
<a class="dropdown-item" href="../articles/other_pkg.html">
2023-05-27 10:53:23 +02:00
<span class="fa fa-layer-group"></span>
2023-05-24 16:03:18 +02:00
AMR &amp; base R
</a>
</div>
</li>
2022-12-27 16:14:41 +01:00
<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>
2023-05-24 16:03:18 +02:00
</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">
2022-12-27 16:14:41 +01:00
<a class="nav-link" href="../news/index.html">
<span class="far fa far fa-newspaper"></span>
Changelog
</a>
</li>
2023-05-24 16:03:18 +02:00
<li class="nav-item">
2022-12-27 16:14:41 +01:00
<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">
2023-01-14 20:00:10 +01:00
<img src="../logo.svg" class="logo" alt=""><h1>Add Custom Microorganisms</h1>
2023-01-14 17:20:52 +01:00
<small class="dont-index">Source: <a href="https://github.com/msberends/AMR/blob/HEAD/R/custom_microorganisms.R" class="external-link"><code>R/custom_microorganisms.R</code></a></small>
2022-12-27 16:14:41 +01:00
<div class="d-none name"><code>add_custom_microorganisms.Rd</code></div>
</div>
<div class="ref-description section level2">
2023-01-14 20:00:10 +01:00
<p>With <code>add_custom_microorganisms()</code> you can add your own custom microorganisms, such the non-taxonomic outcome of laboratory analysis.</p>
2022-12-27 16:14:41 +01:00
</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">add_custom_microorganisms</span><span class="op">(</span><span class="va">x</span><span class="op">)</span></span>
<span></span>
<span><span class="fu">clear_custom_microorganisms</span><span class="op">(</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>
2023-01-14 17:20:52 +01:00
<dd><p>a <a href="https://rdrr.io/r/base/data.frame.html" class="external-link">data.frame</a> resembling the <a href="microorganisms.html">microorganisms</a> data set, at least containing column "genus" (case-insensitive)</p></dd>
2022-12-27 16:14:41 +01:00
</dl></div>
<div class="section level2">
<h2 id="details">Details<a class="anchor" aria-label="anchor" href="#details"></a></h2>
<p>This function will fill in missing taxonomy for you, if specific taxonomic columns are missing, see <em>Examples</em>.</p>
<p><strong>Important:</strong> Due to how <span style="R">R</span> works, the <code>add_custom_microorganisms()</code> function has to be run in every <span style="R">R</span> session - added microorganisms are not stored between sessions and are thus lost when <span style="R">R</span> is exited.</p>
2023-03-12 13:10:15 +01:00
<p>There are two ways to circumvent this and automate the process of adding microorganisms:</p>
2023-02-22 14:47:35 +01:00
<p><strong>Method 1:</strong> Using the <a href="AMR-options.html">package option</a> <code><a href="AMR-options.html">AMR_custom_mo</a></code>, which is the preferred method. To use this method:</p><ol><li><p>Create a data set in the structure of the <a href="microorganisms.html">microorganisms</a> data set (containing at the very least column "genus") and save it with <code><a href="https://rdrr.io/r/base/readRDS.html" class="external-link">saveRDS()</a></code> to a location of choice, e.g. <code>"~/my_custom_mo.rds"</code>, or any remote location.</p></li>
<li><p>Set the file location to the <a href="AMR-options.html">package option</a> <code><a href="AMR-options.html">AMR_custom_mo</a></code>: <code>options(AMR_custom_mo = "~/my_custom_mo.rds")</code>. This can even be a remote file location, such as an https URL. Since options are not saved between <span style="R">R</span> sessions, it is best to save this option to the <code>.Rprofile</code> file so that it will be loaded on start-up of <span style="R">R</span>. To do this, open the <code>.Rprofile</code> file using e.g. <code>utils::file.edit("~/.Rprofile")</code>, add this text and save the file:</p>
2022-12-27 16:14:41 +01:00
<p></p><div class="sourceCode r"><pre><code><span><span class="co"># Add custom microorganism codes:</span></span>
<span><span class="fu"><a href="https://rdrr.io/r/base/options.html" class="external-link">options</a></span><span class="op">(</span>AMR_custom_mo <span class="op">=</span> <span class="st">"~/my_custom_mo.rds"</span><span class="op">)</span></span></code></pre><p></p></div>
<p>Upon package load, this file will be loaded and run through the <code>add_custom_microorganisms()</code> function.</p></li>
2023-03-12 13:10:15 +01:00
</ol><p><strong>Method 2:</strong> Loading the microorganism directly from your <code>.Rprofile</code> file. Note that the definitions will be stored in a user-specific <span style="R">R</span> file, which is a suboptimal workflow. To use this method:</p><ol><li><p>Edit the <code>.Rprofile</code> file using e.g. <code>utils::file.edit("~/.Rprofile")</code>.</p></li>
2022-12-27 16:14:41 +01:00
<li><p>Add a text like below and save the file:</p>
<p></p><div class="sourceCode r"><pre><code><span> <span class="co"># Add custom antibiotic drug codes:</span></span>
2023-01-19 13:03:56 +01:00
<span> <span class="fu">AMR</span><span class="fu">::</span><span class="fu"><a href="../reference/add_custom_microorganisms.html">add_custom_microorganisms</a></span><span class="op">(</span></span>
2022-12-28 14:27:31 +01:00
<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>genus <span class="op">=</span> <span class="st">"Enterobacter"</span>,</span>
2022-12-27 16:14:41 +01:00
<span> species <span class="op">=</span> <span class="st">"asburiae/cloacae"</span><span class="op">)</span></span>
<span> <span class="op">)</span></span></code></pre><p></p></div></li>
2023-03-12 13:10:15 +01:00
</ol><p>Use <code>clear_custom_microorganisms()</code> to clear the previously added microorganisms.</p>
2022-12-27 16:14:41 +01:00
</div>
<div class="section level2">
<h2 id="see-also">See also<a class="anchor" aria-label="anchor" href="#see-also"></a></h2>
2023-01-14 20:00:10 +01:00
<div class="dont-index"><p><code><a href="add_custom_antimicrobials.html">add_custom_antimicrobials()</a></code> to add custom antimicrobials.</p></div>
2022-12-27 16:14:41 +01: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>
<span class="r-in"><span><span class="co"># a combination of species is not formal taxonomy, so</span></span></span>
2023-05-26 20:44:55 +02:00
<span class="r-in"><span><span class="co"># this will result in "Enterobacter cloacae cloacae",</span></span></span>
<span class="r-in"><span><span class="co"># since it resembles the input best:</span></span></span>
2022-12-27 16:14:41 +01:00
<span class="r-in"><span><span class="fu"><a href="mo_property.html">mo_name</a></span><span class="op">(</span><span class="st">"Enterobacter asburiae/cloacae"</span><span class="op">)</span></span></span>
2023-05-26 16:18:12 +02:00
<span class="r-out co"><span class="r-pr">#&gt;</span> [1] "Enterobacter cloacae cloacae"</span>
2022-12-27 16:14:41 +01:00
<span class="r-in"><span></span></span>
<span class="r-in"><span><span class="co"># now add a custom entry - it will be considered by as.mo() and</span></span></span>
<span class="r-in"><span><span class="co"># all mo_*() functions</span></span></span>
<span class="r-in"><span><span class="fu">add_custom_microorganisms</span><span class="op">(</span></span></span>
2023-01-23 15:07:54 +01:00
<span class="r-in"><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> genus <span class="op">=</span> <span class="st">"Enterobacter"</span>,</span></span>
<span class="r-in"><span> species <span class="op">=</span> <span class="st">"asburiae/cloacae"</span></span></span>
2022-12-27 16:14:41 +01:00
<span class="r-in"><span> <span class="op">)</span></span></span>
<span class="r-in"><span><span class="op">)</span></span></span>
2023-01-14 17:20:52 +01:00
<span class="r-msg co"><span class="r-pr">#&gt;</span> Added Enterobacter asburiae/cloacae to the internal microorganisms data</span>
<span class="r-msg co"><span class="r-pr">#&gt;</span> set.</span>
2022-12-27 16:14:41 +01:00
<span class="r-in"><span></span></span>
2022-12-28 14:27:31 +01:00
<span class="r-in"><span><span class="co"># E. asburiae/cloacae is now a new microorganism:</span></span></span>
2022-12-27 16:14:41 +01:00
<span class="r-in"><span><span class="fu"><a href="mo_property.html">mo_name</a></span><span class="op">(</span><span class="st">"Enterobacter asburiae/cloacae"</span><span class="op">)</span></span></span>
<span class="r-out co"><span class="r-pr">#&gt;</span> [1] "Enterobacter asburiae/cloacae"</span>
2022-12-28 15:12:34 +01:00
<span class="r-in"><span></span></span>
2022-12-28 14:27:31 +01:00
<span class="r-in"><span><span class="co"># its code:</span></span></span>
<span class="r-in"><span><span class="fu"><a href="as.mo.html">as.mo</a></span><span class="op">(</span><span class="st">"Enterobacter asburiae/cloacae"</span><span class="op">)</span></span></span>
2022-12-27 16:14:41 +01:00
<span class="r-out co"><span class="r-pr">#&gt;</span> Class 'mo'</span>
2023-05-12 10:43:14 +02:00
<span class="r-out co"><span class="r-pr">#&gt;</span> [1] CUSTOM1_ENTRB_ASB/</span>
2022-12-28 15:12:34 +01:00
<span class="r-in"><span></span></span>
2022-12-27 16:14:41 +01:00
<span class="r-in"><span><span class="co"># all internal algorithms will work as well:</span></span></span>
<span class="r-in"><span><span class="fu"><a href="mo_property.html">mo_name</a></span><span class="op">(</span><span class="st">"Ent asburia cloacae"</span><span class="op">)</span></span></span>
<span class="r-out co"><span class="r-pr">#&gt;</span> [1] "Enterobacter asburiae/cloacae"</span>
<span class="r-in"><span></span></span>
<span class="r-in"><span><span class="co"># and even the taxonomy was added based on the genus!</span></span></span>
2022-12-28 14:27:31 +01:00
<span class="r-in"><span><span class="fu"><a href="mo_property.html">mo_family</a></span><span class="op">(</span><span class="st">"E. asburiae/cloacae"</span><span class="op">)</span></span></span>
2022-12-27 16:14:41 +01:00
<span class="r-out co"><span class="r-pr">#&gt;</span> [1] "Enterobacteriaceae"</span>
<span class="r-in"><span><span class="fu"><a href="mo_property.html">mo_gramstain</a></span><span class="op">(</span><span class="st">"Enterobacter asburiae/cloacae"</span><span class="op">)</span></span></span>
<span class="r-out co"><span class="r-pr">#&gt;</span> [1] "Gram-negative"</span>
<span class="r-in"><span></span></span>
2022-12-28 14:27:31 +01:00
<span class="r-in"><span><span class="fu"><a href="mo_property.html">mo_info</a></span><span class="op">(</span><span class="st">"Enterobacter asburiae/cloacae"</span><span class="op">)</span></span></span>
2023-01-19 13:03:56 +01:00
<span class="r-out co"><span class="r-pr">#&gt;</span> $mo</span>
2023-05-12 10:43:14 +02:00
<span class="r-out co"><span class="r-pr">#&gt;</span> [1] "CUSTOM1_ENTRB_ASB/"</span>
2023-01-14 17:20:52 +01:00
<span class="r-out co"><span class="r-pr">#&gt;</span> </span>
2022-12-27 16:14:41 +01:00
<span class="r-out co"><span class="r-pr">#&gt;</span> $kingdom</span>
<span class="r-out co"><span class="r-pr">#&gt;</span> [1] "Bacteria"</span>
<span class="r-out co"><span class="r-pr">#&gt;</span> </span>
<span class="r-out co"><span class="r-pr">#&gt;</span> $phylum</span>
<span class="r-out co"><span class="r-pr">#&gt;</span> [1] "Pseudomonadota"</span>
<span class="r-out co"><span class="r-pr">#&gt;</span> </span>
<span class="r-out co"><span class="r-pr">#&gt;</span> $class</span>
<span class="r-out co"><span class="r-pr">#&gt;</span> [1] "Gammaproteobacteria"</span>
<span class="r-out co"><span class="r-pr">#&gt;</span> </span>
<span class="r-out co"><span class="r-pr">#&gt;</span> $order</span>
<span class="r-out co"><span class="r-pr">#&gt;</span> [1] "Enterobacterales"</span>
<span class="r-out co"><span class="r-pr">#&gt;</span> </span>
<span class="r-out co"><span class="r-pr">#&gt;</span> $family</span>
<span class="r-out co"><span class="r-pr">#&gt;</span> [1] "Enterobacteriaceae"</span>
<span class="r-out co"><span class="r-pr">#&gt;</span> </span>
<span class="r-out co"><span class="r-pr">#&gt;</span> $genus</span>
<span class="r-out co"><span class="r-pr">#&gt;</span> [1] "Enterobacter"</span>
<span class="r-out co"><span class="r-pr">#&gt;</span> </span>
<span class="r-out co"><span class="r-pr">#&gt;</span> $species</span>
<span class="r-out co"><span class="r-pr">#&gt;</span> [1] "asburiae/cloacae"</span>
<span class="r-out co"><span class="r-pr">#&gt;</span> </span>
<span class="r-out co"><span class="r-pr">#&gt;</span> $subspecies</span>
2022-12-28 14:27:31 +01:00
<span class="r-out co"><span class="r-pr">#&gt;</span> [1] ""</span>
2022-12-27 16:14:41 +01:00
<span class="r-out co"><span class="r-pr">#&gt;</span> </span>
<span class="r-out co"><span class="r-pr">#&gt;</span> $status</span>
<span class="r-out co"><span class="r-pr">#&gt;</span> [1] "accepted"</span>
<span class="r-out co"><span class="r-pr">#&gt;</span> </span>
<span class="r-out co"><span class="r-pr">#&gt;</span> $synonyms</span>
<span class="r-out co"><span class="r-pr">#&gt;</span> NULL</span>
<span class="r-out co"><span class="r-pr">#&gt;</span> </span>
<span class="r-out co"><span class="r-pr">#&gt;</span> $gramstain</span>
<span class="r-out co"><span class="r-pr">#&gt;</span> [1] "Gram-negative"</span>
<span class="r-out co"><span class="r-pr">#&gt;</span> </span>
2023-05-12 10:43:14 +02:00
<span class="r-out co"><span class="r-pr">#&gt;</span> $oxygen_tolerance</span>
<span class="r-out co"><span class="r-pr">#&gt;</span> [1] NA</span>
<span class="r-out co"><span class="r-pr">#&gt;</span> </span>
2022-12-27 16:14:41 +01:00
<span class="r-out co"><span class="r-pr">#&gt;</span> $url</span>
<span class="r-out co"><span class="r-pr">#&gt;</span> [1] ""</span>
<span class="r-out co"><span class="r-pr">#&gt;</span> </span>
<span class="r-out co"><span class="r-pr">#&gt;</span> $ref</span>
2024-02-13 13:53:34 +01:00
<span class="r-out co"><span class="r-pr">#&gt;</span> [1] "Self-added, 2024"</span>
2022-12-27 16:14:41 +01:00
<span class="r-out co"><span class="r-pr">#&gt;</span> </span>
<span class="r-out co"><span class="r-pr">#&gt;</span> $snomed</span>
2023-02-08 17:01:47 +01:00
<span class="r-out co"><span class="r-pr">#&gt;</span> [1] NA</span>
2022-12-27 16:14:41 +01:00
<span class="r-out co"><span class="r-pr">#&gt;</span> </span>
2023-05-12 10:43:14 +02:00
<span class="r-out co"><span class="r-pr">#&gt;</span> $lpsn</span>
<span class="r-out co"><span class="r-pr">#&gt;</span> [1] NA</span>
<span class="r-out co"><span class="r-pr">#&gt;</span> </span>
<span class="r-out co"><span class="r-pr">#&gt;</span> $gbif</span>
<span class="r-out co"><span class="r-pr">#&gt;</span> [1] NA</span>
<span class="r-out co"><span class="r-pr">#&gt;</span> </span>
2023-01-14 17:20:52 +01:00
<span class="r-in"><span></span></span>
<span class="r-in"><span></span></span>
<span class="r-in"><span><span class="co"># the function tries to be forgiving:</span></span></span>
<span class="r-in"><span><span class="fu">add_custom_microorganisms</span><span class="op">(</span></span></span>
2023-01-23 15:07:54 +01:00
<span class="r-in"><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> GENUS <span class="op">=</span> <span class="st">"BACTEROIDES / PARABACTEROIDES SLASHLINE"</span>,</span></span>
<span class="r-in"><span> SPECIES <span class="op">=</span> <span class="st">"SPECIES"</span></span></span>
<span class="r-in"><span> <span class="op">)</span></span></span>
2023-01-14 20:00:10 +01:00
<span class="r-in"><span><span class="op">)</span></span></span>
2023-01-19 13:03:56 +01:00
<span class="r-msg co"><span class="r-pr">#&gt;</span> Added Bacteroides/Parabacteroides to the internal microorganisms data</span>
<span class="r-msg co"><span class="r-pr">#&gt;</span> set.</span>
<span class="r-in"><span><span class="fu"><a href="mo_property.html">mo_name</a></span><span class="op">(</span><span class="st">"BACTEROIDES / PARABACTEROIDES"</span><span class="op">)</span></span></span>
<span class="r-out co"><span class="r-pr">#&gt;</span> [1] "Bacteroides/Parabacteroides"</span>
<span class="r-in"><span><span class="fu"><a href="mo_property.html">mo_rank</a></span><span class="op">(</span><span class="st">"BACTEROIDES / PARABACTEROIDES"</span><span class="op">)</span></span></span>
2023-01-14 20:00:10 +01:00
<span class="r-out co"><span class="r-pr">#&gt;</span> [1] "genus"</span>
2023-01-19 13:03:56 +01:00
<span class="r-in"><span></span></span>
2023-05-26 20:44:55 +02:00
<span class="r-in"><span><span class="co"># taxonomy still works, even though a slashline genus was given as input:</span></span></span>
2023-01-19 13:03:56 +01:00
<span class="r-in"><span><span class="fu"><a href="mo_property.html">mo_family</a></span><span class="op">(</span><span class="st">"Bacteroides/Parabacteroides"</span><span class="op">)</span></span></span>
<span class="r-out co"><span class="r-pr">#&gt;</span> [1] "Bacteroidaceae"</span>
<span class="r-in"><span></span></span>
2023-01-14 17:20:52 +01:00
<span class="r-in"><span></span></span>
2023-01-14 20:00:10 +01:00
<span class="r-in"><span><span class="co"># for groups and complexes, set them as species or subspecies:</span></span></span>
2023-01-14 17:20:52 +01:00
<span class="r-in"><span><span class="fu">add_custom_microorganisms</span><span class="op">(</span></span></span>
2023-01-23 15:07:54 +01:00
<span class="r-in"><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> genus <span class="op">=</span> <span class="st">"Citrobacter"</span>,</span></span>
<span class="r-in"><span> species <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">"freundii"</span>, <span class="st">"braakii complex"</span><span class="op">)</span>,</span></span>
<span class="r-in"><span> subspecies <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">"complex"</span>, <span class="st">""</span><span class="op">)</span></span></span>
<span class="r-in"><span> <span class="op">)</span></span></span>
2023-01-14 20:00:10 +01:00
<span class="r-in"><span><span class="op">)</span></span></span>
<span class="r-msg co"><span class="r-pr">#&gt;</span> Added Citrobacter braakii complex and Citrobacter freundii complex to the</span>
<span class="r-msg co"><span class="r-pr">#&gt;</span> internal microorganisms data set.</span>
<span class="r-in"><span><span class="fu"><a href="mo_property.html">mo_name</a></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">"C. freundii complex"</span>, <span class="st">"C. braakii complex"</span><span class="op">)</span><span class="op">)</span></span></span>
<span class="r-out co"><span class="r-pr">#&gt;</span> [1] "Citrobacter freundii complex" "Citrobacter braakii complex" </span>
<span class="r-in"><span><span class="fu"><a href="mo_property.html">mo_species</a></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">"C. freundii complex"</span>, <span class="st">"C. braakii complex"</span><span class="op">)</span><span class="op">)</span></span></span>
<span class="r-out co"><span class="r-pr">#&gt;</span> [1] "freundii complex" "braakii complex" </span>
<span class="r-in"><span><span class="fu"><a href="mo_property.html">mo_gramstain</a></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">"C. freundii complex"</span>, <span class="st">"C. braakii complex"</span><span class="op">)</span><span class="op">)</span></span></span>
<span class="r-out co"><span class="r-pr">#&gt;</span> [1] "Gram-negative" "Gram-negative"</span>
2022-12-27 16:14:41 +01:00
<span class="r-in"><span><span class="co"># }</span></span></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>