1
0
mirror of https://github.com/msberends/AMR.git synced 2025-07-08 09:11:51 +02:00

cli-147-2126

This commit is contained in:
github-actions
2024-06-19 13:14:41 +00:00
parent 7b8d4eee83
commit 3c6ea5dbb1
77 changed files with 161 additions and 140 deletions

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="">2.1.1.9059</small>
<small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="">2.1.1.9060</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">
@ -159,18 +159,18 @@
</div>
<div class="section level2">
<h2 class="pkg-version" data-toc-text="2.1.1.9059" id="amr-2119059">AMR 2.1.1.9059<a class="anchor" aria-label="anchor" href="#amr-2119059"></a></h2>
<h2 class="pkg-version" data-toc-text="2.1.1.9060" id="amr-2119060">AMR 2.1.1.9060<a class="anchor" aria-label="anchor" href="#amr-2119060"></a></h2>
<p><em>(this beta version will eventually become v3.0. Were happy to reach a new major milestone soon, which will be all about the new One Health support! Install this beta using <a href="https://msberends.github.io/AMR/#latest-development-version">the instructions here</a>.)</em></p>
<div class="section level5">
<h5 id="a-new-milestone-amr-v30-with-one-health-support--human--veterinary--environmental-2-1-1-9059">A New Milestone: AMR v3.0 with One Health Support (= Human + Veterinary + Environmental)<a class="anchor" aria-label="anchor" href="#a-new-milestone-amr-v30-with-one-health-support--human--veterinary--environmental-2-1-1-9059"></a></h5>
<h5 id="a-new-milestone-amr-v30-with-one-health-support--human--veterinary--environmental-2-1-1-9060">A New Milestone: AMR v3.0 with One Health Support (= Human + Veterinary + Environmental)<a class="anchor" aria-label="anchor" href="#a-new-milestone-amr-v30-with-one-health-support--human--veterinary--environmental-2-1-1-9060"></a></h5>
<p>This package now supports not only tools for AMR data analysis in clinical settings, but also for veterinary and environmental microbiology. This was made possible through a collaboration with the <a href="https://www.upei.ca/avc" class="external-link">University of Prince Edward Island</a>, Canada. To celebrate this great improvement of the package, we also updated the package logo to reflect this change.</p>
</div>
<div class="section level3">
<h3 id="breaking-2-1-1-9059">Breaking<a class="anchor" aria-label="anchor" href="#breaking-2-1-1-9059"></a></h3>
<h3 id="breaking-2-1-1-9060">Breaking<a class="anchor" aria-label="anchor" href="#breaking-2-1-1-9060"></a></h3>
<ul><li>Removed all functions and references that used the deprecated <code>rsi</code> class, which were all replaced with their <code>sir</code> equivalents over a year ago</li>
</ul></div>
<div class="section level3">
<h3 id="new-2-1-1-9059">New<a class="anchor" aria-label="anchor" href="#new-2-1-1-9059"></a></h3>
<h3 id="new-2-1-1-9060">New<a class="anchor" aria-label="anchor" href="#new-2-1-1-9060"></a></h3>
<ul><li>One Health implementation
<ul><li>Function <code><a href="../reference/as.sir.html">as.sir()</a></code> now has extensive support for animal breakpoints from CLSI. Use <code>breakpoint_type = "animal"</code> and set the <code>host</code> argument to a variable that contains animal species names.</li>
<li>The <code>clinical_breakpoints</code> data set contains all these breakpoints, and can be downloaded on our <a href="https://msberends.github.io/AMR/articles/datasets.html">download page</a>.</li>
@ -180,24 +180,38 @@
<li>
<code><a href="../reference/ab_property.html">ab_url()</a></code> now supports retrieving the WHOCC url of their ATCvet pages</li>
</ul></li>
<li>EUCAST 2024 and CLSI 2024 are now supported, by adding all of their over 4,000 new clinical breakpoints to the <code>clinical_breakpoints</code> data set for usage in <code><a href="../reference/as.sir.html">as.sir()</a></code>. EUCAST 2024 (v14.0) is now the new default guideline for all MIC and disks diffusion interpretations.</li>
<li>Clinical breakpoints
<ul><li>EUCAST 2024 and CLSI 2024 are now supported, by adding all of their over 4,000 new clinical breakpoints to the <code>clinical_breakpoints</code> data set for usage in <code><a href="../reference/as.sir.html">as.sir()</a></code>. EUCAST 2024 is now the new default guideline for all MIC and disks diffusion interpretations.</li>
<li>
<code><a href="../reference/as.sir.html">as.sir()</a></code> now brings additional factor levels: “NI” for non-interpretable and “SDD” for susceptible dose-dependent. Users can now set their own criteria (using regular expressions) as to what should be considered S, I, R, SDD, and NI. Also, to get quantitative values, <code><a href="https://rdrr.io/r/base/double.html" class="external-link">as.double()</a></code> on a <code>sir</code> object will return 1 for S, 2 for SDD/I, and 3 for R (NI will become <code>NA</code>). Other functions using <code>sir</code> classes (e.g., <code><a href="https://rdrr.io/r/base/summary.html" class="external-link">summary()</a></code>) are updated to reflect the change to contain NI and SDD.</li>
<li>The function group <code>scale_*_mic()</code>, namely: <code><a href="../reference/plot.html">scale_x_mic()</a></code>, <code><a href="../reference/plot.html">scale_y_mic()</a></code>, <code><a href="../reference/plot.html">scale_colour_mic()</a></code> and <code><a href="../reference/plot.html">scale_fill_mic()</a></code>. They are advanced ggplot2 extensions to allow easy plotting of MIC values. They allow for manual range definition and plotting missing intermediate log2 levels.</li>
<code><a href="../reference/as.sir.html">as.sir()</a></code> now brings additional factor levels: “NI” for non-interpretable and “SDD” for susceptible dose-dependent. Currently, the <code>clinical_breakpoints</code> data set contains 24 breakpoints that can return the value “SDD” instead of “I”.</li>
</ul></li>
<li>MIC plotting and transforming
<ul><li>The function group <code>scale_*_mic()</code>, namely: <code><a href="../reference/plot.html">scale_x_mic()</a></code>, <code><a href="../reference/plot.html">scale_y_mic()</a></code>, <code><a href="../reference/plot.html">scale_colour_mic()</a></code> and <code><a href="../reference/plot.html">scale_fill_mic()</a></code>. They are advanced ggplot2 extensions to allow easy plotting of MIC values. They allow for manual range definition and plotting missing intermediate log2 levels.</li>
<li>Function <code><a href="../reference/as.mic.html">rescale_mic()</a></code>, which allows to rescale MIC values to a manually set range. This is the powerhouse behind the <code>scale_*_mic()</code> functions, but it can be used by users directly to e.g. compare equality in MIC distributions by rescaling them to the same range first.</li>
<li>Function <code><a href="../reference/mo_property.html">mo_group_members()</a></code> to retrieve the member microorganisms of a microorganism group. For example, <code>mo_group_members("Strep group C")</code> returns a vector of all microorganisms that are in that group.</li>
</ul></li>
<li>Other
<ul><li>Function <code><a href="../reference/mo_property.html">mo_group_members()</a></code> to retrieve the member microorganisms of a microorganism group. For example, <code>mo_group_members("Strep group C")</code> returns a vector of all microorganisms that are in that group.</li>
</ul></li>
</ul></div>
<div class="section level3">
<h3 id="changed-2-1-1-9059">Changed<a class="anchor" aria-label="anchor" href="#changed-2-1-1-9059"></a></h3>
<ul><li>For SIR interpretation, it is now possible to use column names for argument <code>ab</code>, <code>mo</code>, and <code>uti</code>: <code>as.sir(..., ab = "column1", mo = "column2", uti = "column3")</code>. This greatly improves the flexibility for users.</li>
<li>Extended the antibiotic selectors with <code><a href="../reference/antibiotic_class_selectors.html">nitrofurans()</a></code> and <code><a href="../reference/antibiotic_class_selectors.html">rifamycins()</a></code>
</li>
<h3 id="changed-2-1-1-9060">Changed<a class="anchor" aria-label="anchor" href="#changed-2-1-1-9060"></a></h3>
<ul><li>SIR interpretation
<ul><li>It is now possible to use column names for argument <code>ab</code>, <code>mo</code>, and <code>uti</code>: <code>as.sir(..., ab = "column1", mo = "column2", uti = "column3")</code>. This greatly improves the flexibility for users.</li>
<li>Users can now set their own criteria (using regular expressions) as to what should be considered S, I, R, SDD, and NI.</li>
<li>To get quantitative values, <code><a href="https://rdrr.io/r/base/double.html" class="external-link">as.double()</a></code> on a <code>sir</code> object will return 1 for S, 2 for SDD/I, and 3 for R (NI will become <code>NA</code>). Other functions using <code>sir</code> classes (e.g., <code><a href="https://rdrr.io/r/base/summary.html" class="external-link">summary()</a></code>) are updated to reflect the change to contain NI and SDD.</li>
</ul></li>
<li>
<code>antibiotics</code> data set:
<code>antibiotics</code> data set
<ul><li>Added “clindamycin inducible screening” as <code>CLI1</code>. Since clindamycin is a lincosamide, the antibiotic selector <code><a href="../reference/antibiotic_class_selectors.html">lincosamides()</a></code> now contains the argument <code>only_treatable = TRUE</code> (similar to other antibiotic selectors that contain non-treatable drugs)</li>
<li>Added Amorolfine (<code>AMO</code>, D01AE16), which is now also part of the <code><a href="../reference/antibiotic_class_selectors.html">antifungals()</a></code> selector</li>
</ul></li>
<li>For MICs:
<li>Antibiotic selectors
<ul><li>Added selectors <code><a href="../reference/antibiotic_class_selectors.html">nitrofurans()</a></code> and <code><a href="../reference/antibiotic_class_selectors.html">rifamycins()</a></code>
</li>
<li>When using antibiotic selectors such as <code><a href="../reference/antibiotic_class_selectors.html">aminoglycosides()</a></code> that exclude non-treatable drugs like gentamicin-high, the function now always returns a warning that these can be included using <code>only_treatable = FALSE</code>
</li>
</ul></li>
<li>MICs
<ul><li>Added as valid levels: 4096, 6 powers of 0.0625, and 5 powers of 192 (192, 384, 576, 768, 960)</li>
<li>Added new argument <code>keep_operators</code> to <code><a href="../reference/as.mic.html">as.mic()</a></code>. This can be <code>"all"</code> (default), <code>"none"</code>, or <code>"edges"</code>. This argument is also available in the new <code><a href="../reference/as.mic.html">rescale_mic()</a></code> and <code>scale_*_mic()</code> functions.</li>
<li>Comparisons of MIC values are now more strict. For example, <code>&gt;32</code> is higher than (and never equal to) <code>32</code>. Thus, <code>as.mic("&gt;32") == as.mic(32)</code> now returns <code>FALSE</code>, and <code>as.mic("&gt;32") &gt; as.mic(32)</code> now returns <code>TRUE</code>.</li>
@ -216,12 +230,10 @@
<li>Fix for mapping high level antibiotics in <code><a href="../reference/as.ab.html">as.ab()</a></code> (amphotericin B-high, gentamicin-high, kanamycin-high, streptomycin-high, tobramycin-high)</li>
<li>Improved overall algorithm of <code><a href="../reference/as.ab.html">as.ab()</a></code> for better performance and accuracy</li>
<li>Improved overall algorithm of <code><a href="../reference/as.mo.html">as.mo()</a></code> for better performance and accuracy. Specifically, more weight is given to genus and species combinations in cases where the subspecies is miswritten, so that the result will be the correct genus and species.</li>
<li>When using antibiotic selectors such as <code><a href="../reference/antibiotic_class_selectors.html">aminoglycosides()</a></code> that exclude non-treatable drugs like gentamicin-high, the function now always returns a warning that these can be included using <code>only_treatable = FALSE</code>
</li>
<li>Intermediate log2 levels used for MIC plotting are now more common values instead of following a strict dilution range</li>
</ul></div>
<div class="section level3">
<h3 id="other-2-1-1-9059">Other<a class="anchor" aria-label="anchor" href="#other-2-1-1-9059"></a></h3>
<h3 id="other-2-1-1-9060">Other<a class="anchor" aria-label="anchor" href="#other-2-1-1-9060"></a></h3>
<ul><li>Added Jordan Stull, Matthew Saab, and Javier Sanchez as contributors, to thank them for their valuable input</li>
</ul></div>
</div>