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

Built site for AMR@2.1.1.9242: 29b0ef1

Browse Source
This commit is contained in:
github-actions
2025-04-18 14:12:48 +00:00
parent 80b584cd20
commit 1f5b2f341f
90 changed files with 215 additions and 374 deletions
Download Patch File Download Diff File Expand all files Collapse all files

26
news/index.html
View File

@ -1,5 +1,5 @@
<!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"><title>Changelog • 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/Lato-0.4.9/font.css" rel="stylesheet"><link href="../deps/Fira_Code-0.4.9/font.css" rel="stylesheet"><link href="../deps/font-awesome-6.5.2/css/all.min.css" rel="stylesheet"><link href="../deps/font-awesome-6.5.2/css/v4-shims.min.css" rel="stylesheet"><script src="../deps/headroom-0.11.0/headroom.min.js"></script><script src="../deps/headroom-0.11.0/jQuery.headroom.min.js"></script><script src="../deps/bootstrap-toc-1.0.1/bootstrap-toc.min.js"></script><script src="../deps/clipboard.js-2.0.11/clipboard.min.js"></script><script src="../deps/search-1.0.0/autocomplete.jquery.min.js"></script><script src="../deps/search-1.0.0/fuse.min.js"></script><script src="../deps/search-1.0.0/mark.min.js"></script><!-- pkgdown --><script src="../pkgdown.js"></script><link href="../extra.css" rel="stylesheet"><script src="../extra.js"></script><meta property="og:title" content="Changelog"><meta property="og:image" content="https://amr-for-r.org/logo.svg"><link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/katex@0.16.11/dist/katex.min.css" integrity="sha384-nB0miv6/jRmo5UMMR1wu3Gz6NLsoTkbqJghGIsx//Rlm+ZU03BU6SQNC66uf4l5+" crossorigin="anonymous"><script defer src="https://cdn.jsdelivr.net/npm/katex@0.16.11/dist/katex.min.js" integrity="sha384-7zkQWkzuo3B5mTepMUcHkMB5jZaolc2xDwL6VFqjFALcbeS9Ggm/Yr2r3Dy4lfFg" crossorigin="anonymous"></script><script defer src="https://cdn.jsdelivr.net/npm/katex@0.16.11/dist/contrib/auto-render.min.js" integrity="sha384-43gviWU0YVjaDtb/GhzOouOXtZMP/7XUzwPTstBeZFe/+rCMvRwr4yROQP43s0Xk" crossorigin="anonymous" onload="renderMathInElement(document.body);"></script></head><body>
<!-- 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"><title>Changelog • 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/Lato-0.4.10/font.css" rel="stylesheet"><link href="../deps/Fira_Code-0.4.10/font.css" rel="stylesheet"><link href="../deps/font-awesome-6.5.2/css/all.min.css" rel="stylesheet"><link href="../deps/font-awesome-6.5.2/css/v4-shims.min.css" rel="stylesheet"><script src="../deps/headroom-0.11.0/headroom.min.js"></script><script src="../deps/headroom-0.11.0/jQuery.headroom.min.js"></script><script src="../deps/bootstrap-toc-1.0.1/bootstrap-toc.min.js"></script><script src="../deps/clipboard.js-2.0.11/clipboard.min.js"></script><script src="../deps/search-1.0.0/autocomplete.jquery.min.js"></script><script src="../deps/search-1.0.0/fuse.min.js"></script><script src="../deps/search-1.0.0/mark.min.js"></script><!-- pkgdown --><script src="../pkgdown.js"></script><link href="../extra.css" rel="stylesheet"><script src="../extra.js"></script><meta property="og:title" content="Changelog"><meta property="og:image" content="https://amr-for-r.org/logo.svg"><link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/katex@0.16.11/dist/katex.min.css" integrity="sha384-nB0miv6/jRmo5UMMR1wu3Gz6NLsoTkbqJghGIsx//Rlm+ZU03BU6SQNC66uf4l5+" crossorigin="anonymous"><script defer src="https://cdn.jsdelivr.net/npm/katex@0.16.11/dist/katex.min.js" integrity="sha384-7zkQWkzuo3B5mTepMUcHkMB5jZaolc2xDwL6VFqjFALcbeS9Ggm/Yr2r3Dy4lfFg" crossorigin="anonymous"></script><script defer src="https://cdn.jsdelivr.net/npm/katex@0.16.11/dist/contrib/auto-render.min.js" integrity="sha384-43gviWU0YVjaDtb/GhzOouOXtZMP/7XUzwPTstBeZFe/+rCMvRwr4yROQP43s0Xk" crossorigin="anonymous" onload="renderMathInElement(document.body);"></script></head><body>
<a href="#main" class="visually-hidden-focusable">Skip to contents</a>
@ -7,7 +7,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.9239</small>
<small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="">2.1.1.9242</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">
@ -49,20 +49,20 @@
</div>
<div class="section level2">
<h2 class="pkg-version" data-toc-text="2.1.1.9239" id="amr-2119239">AMR 2.1.1.9239<a class="anchor" aria-label="anchor" href="#amr-2119239"></a></h2>
<h2 class="pkg-version" data-toc-text="2.1.1.9242" id="amr-2119242">AMR 2.1.1.9242<a class="anchor" aria-label="anchor" href="#amr-2119242"></a></h2>
<p><em>(this beta version will eventually become v3.0. We’re 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://amr-for-r.org/#get-this-package">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-9239">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-9239"></a></h5>
<h5 id="a-new-milestone-amr-v30-with-one-health-support--human--veterinary--environmental-2-1-1-9242">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-9242"></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’s Atlantic Veterinary College</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-9239">Breaking<a class="anchor" aria-label="anchor" href="#breaking-2-1-1-9239"></a></h3>
<h3 id="breaking-2-1-1-9242">Breaking<a class="anchor" aria-label="anchor" href="#breaking-2-1-1-9242"></a></h3>
<ul><li>Dataset <code>antibiotics</code> has been renamed to <code>antimicrobials</code> as the data set contains more than just antibiotics. Using <code>antibiotics</code> will still work, but now returns a warning.</li>
<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 two years ago.</li>
<li>Functions <code><a href="../reference/resistance_predict.html">resistance_predict()</a></code> and <code><a href="../reference/resistance_predict.html">sir_predict()</a></code> is now deprecated and will be removed in a future version. Use the <code>tidymodels</code> framework instead, for which we <a href="https://amr-for-r.org/articles/AMR_with_tidymodels.html">wrote a basic introduction</a>.</li>
</ul></div>
<div class="section level3">
<h3 id="new-2-1-1-9239">New<a class="anchor" aria-label="anchor" href="#new-2-1-1-9239"></a></h3>
<h3 id="new-2-1-1-9242">New<a class="anchor" aria-label="anchor" href="#new-2-1-1-9242"></a></h3>
<ul><li>
<strong>One Health implementation</strong>
<ul><li>Function <code><a href="../reference/as.sir.html">as.sir()</a></code> now has extensive support for veterinary 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>
@ -116,21 +116,21 @@
</ul></li>
</ul></div>
<div class="section level3">
<h3 id="changed-2-1-1-9239">Changed<a class="anchor" aria-label="anchor" href="#changed-2-1-1-9239"></a></h3>
<h3 id="changed-2-1-1-9242">Changed<a class="anchor" aria-label="anchor" href="#changed-2-1-1-9242"></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>
<ul><li>It is now possible to use column names for arguments <code>guideline</code>, <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>
<li>Following CLSI interpretation rules, values outside the log2-dilution range will be rounded upwards to the nearest log2-level before interpretation. Only if using a CLSI guideline.</li>
<li>Combined MIC values (e.g., from CLSI) are now supported</li>
<li>The argument <code>conserve_capped_values</code> in <code><a href="../reference/as.sir.html">as.sir()</a></code> has been replaced with <code>capped_mic_handling</code>, which allows greater flexibility in handling capped MIC values (<code>&lt;</code>, <code>&lt;=</code>, <code>&gt;</code>, <code>&gt;=</code>). The four available options (<code>"standard"</code>, <code>"strict"</code>, <code>"relaxed"</code>, <code>"inverse"</code>) provide full control over whether these values should be interpreted conservatively or ignored. Using <code>conserve_capped_values</code> is now deprecated and returns a warning.</li>
<li>Added argument <code>info</code> so silence all console messages</li>
<li>Added argument <code>info</code> to silence all console messages</li>
</ul></li>
<li>
<code><a href="../reference/antibiogram.html">antibiogram()</a></code> function
<ul><li>Argument <code>antibiotics</code> has been renamed to <code>antimicrobials</code>. Using <code>antibiotics</code> will still work, but now returns a warning.</li>
<li>Added argument <code>formatting_type</code> to set any of the 22 options for the formatting of all ‘cells’. This defaults to <code>18</code> for non-WISCA and <code>14</code> for WISCA, changing the output of antibiograms to cells with more info.</li>
<li>For this reason, <code>add_total_n</code> is now <code>FALSE</code> at default since the denominators are added to the cells for non-WISCA. For WISCA, the denominator is not useful anyway.</li>
<li>For this reason, <code>add_total_n</code> is now deprecated and <code>FALSE</code> at default since the denominators are added to the cells dependent on the <code>formatting_type</code> setting</li>
<li>The <code>ab_transform</code> argument now defaults to <code>"name"</code>, displaying antibiotic column names instead of codes</li>
</ul></li>
<li>Antimicrobial selectors (previously: <em>antibiotic selectors</em>)
@ -196,8 +196,8 @@
<li>Added console colours support of <code>sir</code> class for Positron</li>
</ul></div>
<div class="section level3">
<h3 id="other-2-1-1-9239">Other<a class="anchor" aria-label="anchor" href="#other-2-1-1-9239"></a></h3>
<ul><li>New website domain: <a href="https://amr-for-r.org" class="uri">https://amr-for-r.org</a>! The old domain (<a href="https://msberends.github.io/AMR" class="external-link uri">https://msberends.github.io/AMR</a>) will remain to work.</li>
<h3 id="other-2-1-1-9242">Other<a class="anchor" aria-label="anchor" href="#other-2-1-1-9242"></a></h3>
<ul><li>New website domain: <a href="https://amr-for-r.org" class="uri">https://amr-for-r.org</a>! The old domain (<a href="http://amr-for-r.org" class="external-link uri">http://amr-for-r.org</a>) will remain to work.</li>
<li>Added Dr. Larisse Bolton and Aislinn Cook as contributors for their fantastic implementation of WISCA in a mathematically solid way</li>
<li>Added Matthew Saab, Dr. Jordan Stull, and Prof. Javier Sanchez as contributors for their tremendous input on veterinary breakpoints and interpretations</li>
<li>Added Prof. Kathryn Holt, Dr. Jane Hawkey, and Dr. Natacha Couto as contributors for their many suggestions, ideas and bugfixes</li>
@ -206,7 +206,7 @@
<li>Stopped support for SAS (<code>.xpt</code>) files, since their file structure and extremely inefficient and requires more disk space than GitHub allows in a single commit.</li>
</ul></div>
<div class="section level3">
<h3 id="older-versions-2-1-1-9239">Older Versions<a class="anchor" aria-label="anchor" href="#older-versions-2-1-1-9239"></a></h3>
<h3 id="older-versions-2-1-1-9242">Older Versions<a class="anchor" aria-label="anchor" href="#older-versions-2-1-1-9242"></a></h3>
<p>This changelog only contains changes from AMR v3.0 (March 2025) and later.</p>
<ul><li>For prior v2 versions, please see <a href="https://github.com/msberends/AMR/blob/v2.1.1/NEWS.md" class="external-link">our v2 archive</a>.</li>
<li>For prior v1 versions, please see <a href="https://github.com/msberends/AMR/blob/v1.8.2/NEWS.md" class="external-link">our v1 archive</a>.</li>