P281424/AMR
1
0
Fork 0
mirror of https://github.com/msberends/AMR.git synced 2025-07-18 00:43:19 +02:00
Code Releases Activity

Built site for AMR: 1.8.2.9088@08fe5a8

Browse Source
This commit is contained in:
github-actions
2023-01-07 01:01:36 +00:00
parent 32bfbe9286
commit 6151d3f729
98 changed files with 575 additions and 571 deletions
Download Patch File Download Diff File Expand all files Collapse all files

34
reference/mo_property.html
View File

@ -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.9086</small>
<small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="">1.8.2.9088</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">
@ -411,21 +411,21 @@
</ul></div>
<div class="section level2">
<h2 id="details">Details<a class="anchor" aria-label="anchor" href="#details"></a></h2>
<p>All functions will, at default, <strong>not</strong> keep old taxonomic properties, as synonyms are automatically replaced with the current taxonomy. Take for example <em>Escherichia blattae</em>, which was renamed to <em>Shimwellia blattae</em> in 2010:</p><ul><li><p><code>mo_genus("Escherichia blattae")</code> will return <code>"Shemwellia"</code> (with a note about the renaming)</p></li>
<li><p><code>mo_genus("Escherichia blattae", keep_synonyms = TRUE)</code> will return <code>"Escherichia"</code> (with a warning that the name is outdated)</p></li>
<li><p><code>mo_ref("Escherichia blattae")</code> will return <code>"Priest et al., 2010"</code> (with a note)</p></li>
<li><p><code>mo_ref("Escherichia blattae", keep_synonyms = TRUE)</code> will return <code>"Burgess et al., 1973"</code> (with a warning)</p></li>
</ul><p>The short name (<code>mo_shortname()</code>) returns the first character of the genus and the full species, such as <code>"E. coli"</code>, for species and subspecies. 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>All functions will, at default, <strong>not</strong> keep old taxonomic properties, as synonyms are automatically replaced with the current taxonomy. Take for example <em>Enterobacter aerogenes</em>, which was initially named in 1960 but renamed to <em>Klebsiella aerogenes</em> in 2017:</p><ul><li><p><code>mo_genus("Enterobacter aerogenes")</code> will return <code>"Klebsiella"</code> (with a note about the renaming)</p></li>
<li><p><code>mo_genus("Enterobacter aerogenes", keep_synonyms = TRUE)</code> will return <code>"Enterobacter"</code> (with a once-per-session warning that the name is outdated)</p></li>
<li><p><code>mo_ref("Enterobacter aerogenes")</code> will return <code>"Tindall et al., 2017"</code> (with a note)</p></li>
<li><p><code>mo_ref("Enterobacter aerogenes", keep_synonyms = TRUE)</code> will return <code>"Hormaeche et al., 1960"</code> (with a warning)</p></li>
</ul><p>The short name (<code>mo_shortname()</code>) returns the first character of the genus and the full species, such as <code>"E. coli"</code>, for species and subspecies. 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>. As a result, <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 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 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 later 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>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>
<p>All output <a href="translate.html">will be translated</a> where possible.</p>
</div>
<div class="section level2">
<h2 id="matching-score-for-microorganisms">Matching Score for Microorganisms<a class="anchor" aria-label="anchor" href="#matching-score-for-microorganisms"></a></h2>
@ -570,14 +570,14 @@
<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">#&gt;</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>
<span class="r-out co"><span class="r-pr">#&gt;</span> [1] "Streptococcus Group A"</span>
<span class="r-in"><span><span class="fu">mo_shortname</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">#&gt;</span> [1] "S. pyogenes"</span>
<span class="r-in"><span><span class="fu">mo_shortname</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>
<span class="r-out co"><span class="r-pr">#&gt;</span> [1] "GAS"</span>
<span class="r-in"><span><span class="fu">mo_fullname</span><span class="op">(</span><span class="st">"Strep Group B"</span><span class="op">)</span></span></span>
<span class="r-out co"><span class="r-pr">#&gt;</span> [1] "Streptococcus Group B"</span>
<span class="r-in"><span><span class="fu">mo_fullname</span><span class="op">(</span><span class="st">"Strep Group B"</span>, Lancefield <span class="op">=</span> <span class="cn">TRUE</span><span class="op">)</span></span></span>
<span class="r-out co"><span class="r-pr">#&gt;</span> [1] "Streptococcus Group B"</span>
<span class="r-in"><span><span class="fu">mo_shortname</span><span class="op">(</span><span class="st">"Strep Group B"</span><span class="op">)</span></span></span>
<span class="r-out co"><span class="r-pr">#&gt;</span> [1] "GBS"</span>
<span class="r-in"><span><span class="fu">mo_shortname</span><span class="op">(</span><span class="st">"Strep Group B"</span>, Lancefield <span class="op">=</span> <span class="cn">TRUE</span><span class="op">)</span></span></span>
<span class="r-out co"><span class="r-pr">#&gt;</span> [1] "GBS"</span>
<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>
@ -593,7 +593,7 @@
<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">"uk"</span><span class="op">)</span> <span class="co"># Ukrainian</span></span></span>
<span class="r-out co"><span class="r-pr">#&gt;</span> [1] "Грамнегативні"</span>
<span class="r-in"><span></span></span>
<span class="r-in"><span><span class="co"># mo_type is equal to mo_kingdom, but mo_kingdom will remain official</span></span></span>
<span class="r-in"><span><span class="co"># mo_type is equal to mo_kingdom, but mo_kingdom will remain untranslated</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">#&gt;</span> [1] "Bacteria"</span>
<span class="r-in"><span><span class="fu">mo_type</span><span class="op">(</span><span class="st">"Klebsiella pneumoniae"</span><span class="op">)</span></span></span>