mirror of
https://github.com/msberends/AMR.git
synced 2025-07-18 03:23:21 +02:00
Built site for AMR: 1.8.2.9084@86e28ba
This commit is contained in:
github-actions
@ -10,7 +10,7 @@
|
||||
|
||||
<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.9083</small>
|
||||
<small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="">1.8.2.9084</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">
|
||||
@ -236,6 +236,13 @@
|
||||
<span> <span class="va">...</span></span>
|
||||
<span><span class="op">)</span></span>
|
||||
<span></span>
|
||||
<span><span class="fu">mo_pathogenicity</span><span class="op">(</span></span>
|
||||
<span> <span class="va">x</span>,</span>
|
||||
<span> language <span class="op">=</span> <span class="fu"><a href="translate.html">get_AMR_locale</a></span><span class="op">(</span><span class="op">)</span>,</span>
|
||||
<span> keep_synonyms <span class="op">=</span> <span class="fu"><a href="https://rdrr.io/r/base/options.html" class="external-link">getOption</a></span><span class="op">(</span><span class="st">"AMR_keep_synonyms"</span>, <span class="cn">FALSE</span><span class="op">)</span>,</span>
|
||||
<span> <span class="va">...</span></span>
|
||||
<span><span class="op">)</span></span>
|
||||
<span></span>
|
||||
<span><span class="fu">mo_gramstain</span><span class="op">(</span></span>
|
||||
<span> <span class="va">x</span>,</span>
|
||||
<span> language <span class="op">=</span> <span class="fu"><a href="translate.html">get_AMR_locale</a></span><span class="op">(</span><span class="op">)</span>,</span>
|
||||
@ -396,6 +403,7 @@
|
||||
|
||||
|
||||
<ul><li><p>An <a href="https://rdrr.io/r/base/integer.html" class="external-link">integer</a> in case of <code>mo_year()</code></p></li>
|
||||
<li><p>An <a href="https://rdrr.io/r/base/factor.html" class="external-link">ordered factor</a> in case of <code>mo_pathogenicity()</code></p></li>
|
||||
<li><p>A <a href="https://rdrr.io/r/base/list.html" class="external-link">list</a> in case of <code>mo_taxonomy()</code>, <code>mo_synonyms()</code> and <code>mo_info()</code></p></li>
|
||||
<li><p>A named <a href="https://rdrr.io/r/base/character.html" class="external-link">character</a> in case of <code>mo_url()</code></p></li>
|
||||
<li><p>A <a href="https://rdrr.io/r/base/numeric.html" class="external-link">numeric</a> in case of <code>mo_snomed()</code></p></li>
|
||||
@ -408,12 +416,14 @@
|
||||
<li><p><code>mo_ref("Shimwellia blattae", keep_synonyms = FALSE)</code> will return <code>"Priest et al., 2010"</code> (without a note)</p></li>
|
||||
</ul><p>The short name - <code>mo_shortname()</code> - almost always returns the first character of the genus and the full species, like <code>"E. coli"</code>. Exceptions are abbreviations of staphylococci (such as <em>"CoNS"</em>, Coagulase-Negative Staphylococci) and beta-haemolytic streptococci (such as <em>"GBS"</em>, Group B Streptococci). Please bear in mind that e.g. <em>E. coli</em> could mean <em>Escherichia coli</em> (kingdom of Bacteria) as well as <em>Entamoeba coli</em> (kingdom of Protozoa). Returning to the full name will be done using <code><a href="as.mo.html">as.mo()</a></code> internally, giving priority to bacteria and human pathogens, i.e. <code>"E. coli"</code> will be considered <em>Escherichia coli</em>. In other words, <code>mo_fullname(mo_shortname("Entamoeba coli"))</code> returns <code>"Escherichia coli"</code>.</p>
|
||||
<p>Since the top-level of the taxonomy is sometimes referred to as 'kingdom' and sometimes as 'domain', the functions <code>mo_kingdom()</code> and <code>mo_domain()</code> return the exact same results.</p>
|
||||
<p>Determination of the Gram stain - <code>mo_gramstain()</code> - will be based on the taxonomic kingdom and phylum. Originally, Cavalier-Smith defined the so-called subkingdoms Negibacteria and Posibacteria (2002, <a href="https://pubmed.ncbi.nlm.nih.gov/11837318/" class="external-link">PMID 11837318</a>), and only considered these phyla as Posibacteria: Actinobacteria, Chloroflexi, Firmicutes, and Tenericutes. These phyla were renamed to Actinomycetota, Chloroflexota, Bacillota, and Mycoplasmatota (2021, <a href="https://pubmed.ncbi.nlm.nih.gov/34694987/" class="external-link">PMID 34694987</a>). Bacteria in these phyla are considered Gram-positive in this <code>AMR</code> package, except for members of the class Negativicutes (within phylum Bacillota) which are Gram-negative. All other bacteria are considered Gram-negative. Species outside the kingdom of Bacteria will return a value <code>NA</code>. Functions <code>mo_is_gram_negative()</code> and <code>mo_is_gram_positive()</code> always return <code>TRUE</code> or <code>FALSE</code> (or <code>NA</code> when the input is <code>NA</code> or the MO code is <code>UNKNOWN</code>), thus always return <code>FALSE</code> for species outside the taxonomic kingdom of Bacteria.</p>
|
||||
<p>Determination of yeasts - <code>mo_is_yeast()</code> - will be based on the taxonomic kingdom and class. <em>Budding yeasts</em> are fungi of the phylum Ascomycota, class Saccharomycetes (also called Hemiascomycetes). <em>True yeasts</em> are aggregated into the underlying order Saccharomycetales. Thus, for all microorganisms that are member of the taxonomic class Saccharomycetes, the function will return <code>TRUE</code>. It returns <code>FALSE</code> otherwise (or <code>NA</code> when the input is <code>NA</code> or the MO code is <code>UNKNOWN</code>).</p>
|
||||
<p>Determination of intrinsic resistance - <code>mo_is_intrinsic_resistant()</code> - will be based on the <a href="intrinsic_resistant.html">intrinsic_resistant</a> data set, which is based on <a href="https://www.eucast.org/expert_rules_and_expected_phenotypes/" class="external-link">'EUCAST Expert Rules' and 'EUCAST Intrinsic Resistance and Unusual Phenotypes' v3.3</a> (2021). The <code>mo_is_intrinsic_resistant()</code> function can be vectorised over both argument <code>x</code> (input for microorganisms) and <code>ab</code> (input for antibiotics).</p>
|
||||
<p>Determination of human pathogenicity (<code>mo_pathogenicity()</code>) is strongly based on Bartlett <em>et al.</em> (2022, <a href="https://doi.org/10.1099/mic.0.001269" class="external-link">doi:10.1099/mic.0.001269</a>
|
||||
). This function returns a <a href="https://rdrr.io/r/base/factor.html" class="external-link">factor</a> with the levels <em>Pathogenic</em>, <em>Potentially pathogenic</em>, <em>Non-pathogenic</em>, and <em>Unknown</em>.</p>
|
||||
<p>Determination of the Gram stain (<code>mo_gramstain()</code>) will be based on the taxonomic kingdom and phylum. Originally, Cavalier-Smith defined the so-called subkingdoms Negibacteria and Posibacteria (2002, <a href="https://pubmed.ncbi.nlm.nih.gov/11837318/" class="external-link">PMID 11837318</a>), and only considered these phyla as Posibacteria: Actinobacteria, Chloroflexi, Firmicutes, and Tenericutes. These phyla were renamed to Actinomycetota, Chloroflexota, Bacillota, and Mycoplasmatota (2021, <a href="https://pubmed.ncbi.nlm.nih.gov/34694987/" class="external-link">PMID 34694987</a>). Bacteria in these phyla are considered Gram-positive in this <code>AMR</code> package, except for members of the class Negativicutes (within phylum Bacillota) which are Gram-negative. All other bacteria are considered Gram-negative. Species outside the kingdom of Bacteria will return a value <code>NA</code>. Functions <code>mo_is_gram_negative()</code> and <code>mo_is_gram_positive()</code> always return <code>TRUE</code> or <code>FALSE</code> (or <code>NA</code> when the input is <code>NA</code> or the MO code is <code>UNKNOWN</code>), thus always return <code>FALSE</code> for species outside the taxonomic kingdom of Bacteria.</p>
|
||||
<p>Determination of yeasts (<code>mo_is_yeast()</code>) will be based on the taxonomic kingdom and class. <em>Budding yeasts</em> are fungi of the phylum Ascomycota, class Saccharomycetes (also called Hemiascomycetes). <em>True yeasts</em> are aggregated into the underlying order Saccharomycetales. Thus, for all microorganisms that are member of the taxonomic class Saccharomycetes, the function will return <code>TRUE</code>. It returns <code>FALSE</code> otherwise (or <code>NA</code> when the input is <code>NA</code> or the MO code is <code>UNKNOWN</code>).</p>
|
||||
<p>Determination of intrinsic resistance (<code>mo_is_intrinsic_resistant()</code>) will be based on the <a href="intrinsic_resistant.html">intrinsic_resistant</a> data set, which is based on <a href="https://www.eucast.org/expert_rules_and_expected_phenotypes/" class="external-link">'EUCAST Expert Rules' and 'EUCAST Intrinsic Resistance and Unusual Phenotypes' v3.3</a> (2021). The <code>mo_is_intrinsic_resistant()</code> function can be vectorised over both argument <code>x</code> (input for microorganisms) and <code>ab</code> (input for antibiotics).</p>
|
||||
<p>All output <a href="translate.html">will be translated</a> where possible.</p>
|
||||
<p>The function <code>mo_url()</code> will return the direct URL to the online database entry, which also shows the scientific reference of the concerned species.</p>
|
||||
<p>SNOMED codes - <code>mo_snomed()</code> - are from the version of 1 July, 2021. See <em>Source</em> and the <a href="microorganisms.html">microorganisms</a> data set for more info.</p>
|
||||
<p>SNOMED codes (<code>mo_snomed()</code>) are from the version of 1 July, 2021. See <em>Source</em> and the <a href="microorganisms.html">microorganisms</a> data set for more info.</p>
|
||||
<p>Old taxonomic names (so-called 'synonyms') can be retrieved with <code>mo_synonyms()</code>, the current taxonomic name can be retrieved with <code>mo_current()</code>. Both functions return full names.</p>
|
||||
</div>
|
||||
<div class="section level2">
|
||||
@ -470,6 +480,7 @@
|
||||
<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"># taxonomic tree -----------------------------------------------------------</span></span></span>
|
||||
<span class="r-in"><span></span></span>
|
||||
<span class="r-in"><span><span class="fu">mo_kingdom</span><span class="op">(</span><span class="st">"Klebsiella pneumoniae"</span><span class="op">)</span></span></span>
|
||||
<span class="r-out co"><span class="r-pr">#></span> [1] "Bacteria"</span>
|
||||
<span class="r-in"><span><span class="fu">mo_phylum</span><span class="op">(</span><span class="st">"Klebsiella pneumoniae"</span><span class="op">)</span></span></span>
|
||||
@ -487,7 +498,9 @@
|
||||
<span class="r-in"><span><span class="fu">mo_subspecies</span><span class="op">(</span><span class="st">"Klebsiella pneumoniae"</span><span class="op">)</span></span></span>
|
||||
<span class="r-out co"><span class="r-pr">#></span> [1] ""</span>
|
||||
<span class="r-in"><span></span></span>
|
||||
<span class="r-in"><span><span class="co"># colloquial properties ----------------------------------------------------</span></span></span>
|
||||
<span class="r-in"><span></span></span>
|
||||
<span class="r-in"><span><span class="co"># full names and short names -----------------------------------------------</span></span></span>
|
||||
<span class="r-in"><span></span></span>
|
||||
<span class="r-in"><span><span class="fu">mo_name</span><span class="op">(</span><span class="st">"Klebsiella pneumoniae"</span><span class="op">)</span></span></span>
|
||||
<span class="r-out co"><span class="r-pr">#></span> [1] "Klebsiella pneumoniae"</span>
|
||||
<span class="r-in"><span><span class="fu">mo_fullname</span><span class="op">(</span><span class="st">"Klebsiella pneumoniae"</span><span class="op">)</span></span></span>
|
||||
@ -495,7 +508,12 @@
|
||||
<span class="r-in"><span><span class="fu">mo_shortname</span><span class="op">(</span><span class="st">"Klebsiella pneumoniae"</span><span class="op">)</span></span></span>
|
||||
<span class="r-out co"><span class="r-pr">#></span> [1] "K. pneumoniae"</span>
|
||||
<span class="r-in"><span></span></span>
|
||||
<span class="r-in"><span></span></span>
|
||||
<span class="r-in"><span><span class="co"># other properties ---------------------------------------------------------</span></span></span>
|
||||
<span class="r-in"><span></span></span>
|
||||
<span class="r-in"><span><span class="fu">mo_pathogenicity</span><span class="op">(</span><span class="st">"Klebsiella pneumoniae"</span><span class="op">)</span></span></span>
|
||||
<span class="r-out co"><span class="r-pr">#></span> [1] Pathogenic</span>
|
||||
<span class="r-out co"><span class="r-pr">#></span> Levels: Pathogenic < Potentially pathogenic < Non-pathogenic < Unknown</span>
|
||||
<span class="r-in"><span><span class="fu">mo_gramstain</span><span class="op">(</span><span class="st">"Klebsiella pneumoniae"</span><span class="op">)</span></span></span>
|
||||
<span class="r-out co"><span class="r-pr">#></span> [1] "Gram-negative"</span>
|
||||
<span class="r-in"><span><span class="fu">mo_snomed</span><span class="op">(</span><span class="st">"Klebsiella pneumoniae"</span><span class="op">)</span></span></span>
|
||||
@ -508,10 +526,12 @@
|
||||
<span class="r-in"><span><span class="fu">mo_url</span><span class="op">(</span><span class="st">"Klebsiella pneumoniae"</span><span class="op">)</span></span></span>
|
||||
<span class="r-out co"><span class="r-pr">#></span> Klebsiella pneumoniae </span>
|
||||
<span class="r-out co"><span class="r-pr">#></span> "https://lpsn.dsmz.de/species/klebsiella-pneumoniae" </span>
|
||||
<span class="r-in"><span><span class="fu">mo_synonyms</span><span class="op">(</span><span class="st">"Klebsiella pneumoniae"</span><span class="op">)</span></span></span>
|
||||
<span class="r-out co"><span class="r-pr">#></span> NULL</span>
|
||||
<span class="r-in"><span><span class="fu">mo_is_yeast</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">"Candida"</span>, <span class="st">"Trichophyton"</span>, <span class="st">"Klebsiella"</span><span class="op">)</span><span class="op">)</span></span></span>
|
||||
<span class="r-out co"><span class="r-pr">#></span> [1] TRUE FALSE FALSE</span>
|
||||
<span class="r-in"><span></span></span>
|
||||
<span class="r-in"><span></span></span>
|
||||
<span class="r-in"><span><span class="co"># scientific reference -----------------------------------------------------</span></span></span>
|
||||
<span class="r-in"><span></span></span>
|
||||
<span class="r-in"><span><span class="fu">mo_ref</span><span class="op">(</span><span class="st">"Klebsiella pneumoniae"</span><span class="op">)</span></span></span>
|
||||
<span class="r-out co"><span class="r-pr">#></span> [1] "Trevisan, 1887"</span>
|
||||
<span class="r-in"><span><span class="fu">mo_authors</span><span class="op">(</span><span class="st">"Klebsiella pneumoniae"</span><span class="op">)</span></span></span>
|
||||
@ -522,8 +542,12 @@
|
||||
<span class="r-out co"><span class="r-pr">#></span> [1] "777151"</span>
|
||||
<span class="r-in"><span><span class="fu">mo_gbif</span><span class="op">(</span><span class="st">"Klebsiella pneumoniae"</span><span class="op">)</span></span></span>
|
||||
<span class="r-out co"><span class="r-pr">#></span> [1] "3221874"</span>
|
||||
<span class="r-in"><span><span class="fu">mo_synonyms</span><span class="op">(</span><span class="st">"Klebsiella pneumoniae"</span><span class="op">)</span></span></span>
|
||||
<span class="r-out co"><span class="r-pr">#></span> NULL</span>
|
||||
<span class="r-in"><span></span></span>
|
||||
<span class="r-in"><span></span></span>
|
||||
<span class="r-in"><span><span class="co"># abbreviations known in the field -----------------------------------------</span></span></span>
|
||||
<span class="r-in"><span></span></span>
|
||||
<span class="r-in"><span><span class="fu">mo_genus</span><span class="op">(</span><span class="st">"MRSA"</span><span class="op">)</span></span></span>
|
||||
<span class="r-out co"><span class="r-pr">#></span> [1] "Staphylococcus"</span>
|
||||
<span class="r-in"><span><span class="fu">mo_species</span><span class="op">(</span><span class="st">"MRSA"</span><span class="op">)</span></span></span>
|
||||
@ -538,14 +562,18 @@
|
||||
<span class="r-in"><span><span class="fu">mo_species</span><span class="op">(</span><span class="st">"EHEC"</span><span class="op">)</span></span></span>
|
||||
<span class="r-out co"><span class="r-pr">#></span> [1] "coli"</span>
|
||||
<span class="r-in"><span></span></span>
|
||||
<span class="r-in"><span></span></span>
|
||||
<span class="r-in"><span><span class="co"># known subspecies ---------------------------------------------------------</span></span></span>
|
||||
<span class="r-in"><span></span></span>
|
||||
<span class="r-in"><span><span class="fu">mo_fullname</span><span class="op">(</span><span class="st">"K. pneu rh"</span><span class="op">)</span></span></span>
|
||||
<span class="r-out co"><span class="r-pr">#></span> [1] "Klebsiella pneumoniae rhinoscleromatis"</span>
|
||||
<span class="r-in"><span><span class="fu">mo_shortname</span><span class="op">(</span><span class="st">"K. pneu rh"</span><span class="op">)</span></span></span>
|
||||
<span class="r-out co"><span class="r-pr">#></span> [1] "K. pneumoniae"</span>
|
||||
<span class="r-in"><span></span></span>
|
||||
<span class="r-in"><span></span></span>
|
||||
<span class="r-in"><span><span class="co"># \donttest{</span></span></span>
|
||||
<span class="r-in"><span><span class="co"># Becker classification, see ?as.mo ----------------------------------------</span></span></span>
|
||||
<span class="r-in"><span></span></span>
|
||||
<span class="r-in"><span><span class="fu">mo_fullname</span><span class="op">(</span><span class="st">"Staph. epidermidis"</span><span class="op">)</span></span></span>
|
||||
<span class="r-out co"><span class="r-pr">#></span> [1] "Staphylococcus epidermidis"</span>
|
||||
<span class="r-in"><span><span class="fu">mo_fullname</span><span class="op">(</span><span class="st">"Staph. epidermidis"</span>, Becker <span class="op">=</span> <span class="cn">TRUE</span><span class="op">)</span></span></span>
|
||||
@ -555,7 +583,9 @@
|
||||
<span class="r-in"><span><span class="fu">mo_shortname</span><span class="op">(</span><span class="st">"Staph. epidermidis"</span>, Becker <span class="op">=</span> <span class="cn">TRUE</span><span class="op">)</span></span></span>
|
||||
<span class="r-out co"><span class="r-pr">#></span> [1] "CoNS"</span>
|
||||
<span class="r-in"><span></span></span>
|
||||
<span class="r-in"><span></span></span>
|
||||
<span class="r-in"><span><span class="co"># Lancefield classification, see ?as.mo ------------------------------------</span></span></span>
|
||||
<span class="r-in"><span></span></span>
|
||||
<span class="r-in"><span><span class="fu">mo_fullname</span><span class="op">(</span><span class="st">"S. pyo"</span><span class="op">)</span></span></span>
|
||||
<span class="r-out co"><span class="r-pr">#></span> [1] "Streptococcus pyogenes"</span>
|
||||
<span class="r-in"><span><span class="fu">mo_fullname</span><span class="op">(</span><span class="st">"S. pyo"</span>, Lancefield <span class="op">=</span> <span class="cn">TRUE</span><span class="op">)</span></span></span>
|
||||
@ -567,6 +597,7 @@
|
||||
<span class="r-in"><span></span></span>
|
||||
<span class="r-in"><span></span></span>
|
||||
<span class="r-in"><span><span class="co"># language support --------------------------------------------------------</span></span></span>
|
||||
<span class="r-in"><span></span></span>
|
||||
<span class="r-in"><span><span class="fu">mo_gramstain</span><span class="op">(</span><span class="st">"Klebsiella pneumoniae"</span>, language <span class="op">=</span> <span class="st">"de"</span><span class="op">)</span> <span class="co"># German</span></span></span>
|
||||
<span class="r-out co"><span class="r-pr">#></span> [1] "Gramnegativ"</span>
|
||||
<span class="r-in"><span><span class="fu">mo_gramstain</span><span class="op">(</span><span class="st">"Klebsiella pneumoniae"</span>, language <span class="op">=</span> <span class="st">"nl"</span><span class="op">)</span> <span class="co"># Dutch</span></span></span>
|
||||
@ -596,9 +627,6 @@
|
||||
<span class="r-in"><span></span></span>
|
||||
<span class="r-in"><span><span class="co"># other --------------------------------------------------------------------</span></span></span>
|
||||
<span class="r-in"><span></span></span>
|
||||
<span class="r-in"><span><span class="fu">mo_is_yeast</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">"Candida"</span>, <span class="st">"Trichophyton"</span>, <span class="st">"Klebsiella"</span><span class="op">)</span><span class="op">)</span></span></span>
|
||||
<span class="r-out co"><span class="r-pr">#></span> [1] TRUE FALSE FALSE</span>
|
||||
<span class="r-in"><span></span></span>
|
||||
<span class="r-in"><span><span class="co"># gram stains and intrinsic resistance can be used as a filter in dplyr verbs</span></span></span>
|
||||
<span class="r-in"><span><span class="kw">if</span> <span class="op">(</span><span class="kw"><a href="https://rdrr.io/r/base/library.html" class="external-link">require</a></span><span class="op">(</span><span class="st"><a href="https://dplyr.tidyverse.org" class="external-link">"dplyr"</a></span><span class="op">)</span><span class="op">)</span> <span class="op">{</span></span></span>
|
||||
<span class="r-in"><span> <span class="va">example_isolates</span> <span class="op"><a href="https://magrittr.tidyverse.org/reference/pipe.html" class="external-link">%>%</a></span></span></span>
|
||||
@ -659,7 +687,6 @@
|
||||
<span class="r-out co"><span class="r-pr">#></span> <span style="color: #BCBCBC;">19</span> Leuconostoc 1</span>
|
||||
<span class="r-out co"><span class="r-pr">#></span> <span style="color: #BCBCBC;">20</span> Pseudescherichia 1</span>
|
||||
<span class="r-in"><span></span></span>
|
||||
<span class="r-in"><span></span></span>
|
||||
<span class="r-in"><span><span class="co"># get a list with the complete taxonomy (from kingdom to subspecies)</span></span></span>
|
||||
<span class="r-in"><span><span class="fu">mo_taxonomy</span><span class="op">(</span><span class="st">"Klebsiella pneumoniae"</span><span class="op">)</span></span></span>
|
||||
<span class="r-out co"><span class="r-pr">#></span> $kingdom</span>
|
||||
|
||||
Reference in New Issue
Block a user