1
0
mirror of https://github.com/msberends/AMR.git synced 2024-12-25 06:46:11 +01:00
AMR/news/index.html
2024-12-20 10:03:24 +00:00

200 lines
23 KiB
HTML
Raw Permalink Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!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://msberends.github.io/AMR/logo.svg"></head><body>
<a href="#main" class="visually-hidden-focusable">Skip to contents</a>
<nav class="navbar navbar-expand-lg fixed-top bg-primary" data-bs-theme="dark" aria-label="Site navigation"><div class="container">
<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.9122</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">
<span class="navbar-toggler-icon"></span>
</button>
<div id="navbar" class="collapse navbar-collapse ms-3">
<ul class="navbar-nav me-auto"><li class="nav-item dropdown">
<button class="nav-link dropdown-toggle" type="button" id="dropdown-how-to" data-bs-toggle="dropdown" aria-expanded="false" aria-haspopup="true"><span class="fa fa-question-circle"></span> How to</button>
<ul class="dropdown-menu" aria-labelledby="dropdown-how-to"><li><a class="dropdown-item" href="../articles/AMR.html"><span class="fa fa-directions"></span> Conduct AMR Analysis</a></li>
<li><a class="dropdown-item" href="../reference/antibiogram.html"><span class="fa fa-file-prescription"></span> Generate Antibiogram (Trad./Syndromic/WISCA)</a></li>
<li><a class="dropdown-item" href="../articles/resistance_predict.html"><span class="fa fa-dice"></span> Predict Antimicrobial Resistance</a></li>
<li><a class="dropdown-item" href="../articles/datasets.html"><span class="fa fa-database"></span> Download Data Sets for Own Use</a></li>
<li><a class="dropdown-item" href="../articles/AMR_with_tidymodels.html"><span class="fa fa-square-root-variable"></span> Use AMR for Predictive Modelling (tidymodels)</a></li>
<li><a class="dropdown-item" href="../reference/AMR-options.html"><span class="fa fa-gear"></span> Set User- Or Team-specific Package Settings</a></li>
<li><a class="dropdown-item" href="../articles/PCA.html"><span class="fa fa-compress"></span> Conduct Principal Component Analysis for AMR</a></li>
<li><a class="dropdown-item" href="../articles/MDR.html"><span class="fa fa-skull-crossbones"></span> Determine Multi-Drug Resistance (MDR)</a></li>
<li><a class="dropdown-item" href="../articles/WHONET.html"><span class="fa fa-globe-americas"></span> Work with WHONET Data</a></li>
<li><a class="dropdown-item" href="../articles/EUCAST.html"><span class="fa fa-exchange-alt"></span> Apply Eucast Rules</a></li>
<li><a class="dropdown-item" href="../reference/mo_property.html"><span class="fa fa-bug"></span> Get Taxonomy of a Microorganism</a></li>
<li><a class="dropdown-item" href="../reference/ab_property.html"><span class="fa fa-capsules"></span> Get Properties of an Antibiotic Drug</a></li>
<li><a class="dropdown-item" href="../reference/av_property.html"><span class="fa fa-capsules"></span> Get Properties of an Antiviral Drug</a></li>
</ul></li>
<li class="nav-item"><a class="nav-link" href="../articles/AMR_for_Python.html"><span class="fa fab fa-python"></span> AMR for Python</a></li>
<li class="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>
</ul><ul class="navbar-nav"><li class="active nav-item"><a class="nav-link" href="../news/index.html"><span class="fa far fa-newspaper"></span> Changelog</a></li>
<li class="nav-item"><a class="external-link nav-link" href="https://github.com/msberends/AMR"><span class="fa fab fa-github"></span> Source Code</a></li>
</ul></div>
</div>
</nav><div class="container template-news">
<div class="row">
<main id="main" class="col-md-9"><div class="page-header">
<img src="../logo.svg" class="logo" alt=""><h1>Changelog</h1>
<small>Source: <a href="https://github.com/msberends/AMR/blob/main/NEWS.md" class="external-link"><code>NEWS.md</code></a></small>
</div>
<div class="section level2">
<h2 class="pkg-version" data-toc-text="2.1.1.9122" id="amr-2119122">AMR 2.1.1.9122<a class="anchor" aria-label="anchor" href="#amr-2119122"></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-9122">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-9122"></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 Islands 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-9122">Breaking<a class="anchor" aria-label="anchor" href="#breaking-2-1-1-9122"></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-9122">New<a class="anchor" aria-label="anchor" href="#new-2-1-1-9122"></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>
<li>The CLSI VET09 guideline has been implemented to address cases where veterinary breakpoints are missing (only applies when <code>guideline</code> is set to CLSI)</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>
<li>The <code>antibiotics</code> data set contains all veterinary antibiotics, such as pradofloxacin and enrofloxacin. All WHOCC codes for veterinary use have been added as well.</li>
<li>
<code><a href="../reference/ab_property.html">ab_atc()</a></code> now supports ATC codes of veterinary antibiotics (that all start with “Q”)</li>
<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>
<strong>Major update to fungal taxonomy and tools for mycologists</strong>
<ul><li>MycoBank has now been integrated as the primary taxonomic source for fungi. The <code>microorganisms</code> data set has been enriched with new columns (<code>mycobank</code>, <code>mycobank_parent</code>, and <code>mycobank_renamed_to</code>) that provide detailed information for fungal species.</li>
<li>A remarkable addition of over 20,000 new fungal records</li>
<li>New function <code><a href="../reference/mo_property.html">mo_mycobank()</a></code> to retrieve the MycoBank record number, analogous to existing functions such as <code><a href="../reference/mo_property.html">mo_lpsn()</a></code> and <code><a href="../reference/mo_property.html">mo_gbif()</a></code>.</li>
<li>The <code><a href="../reference/as.mo.html">as.mo()</a></code> function and all <code>mo_*()</code> functions now include an <code>only_fungi</code> argument, allowing users to restrict results solely to fungal species. This ensures fungi are prioritised over bacteria during microorganism identification. This can also be set globally with the new <code>AMR_only_fungi</code> option.</li>
<li>Also updated other kingdoms, welcoming a total of 2,149 new records from 2023 and 927 from 2024.</li>
</ul></li>
<li>
<strong>Updated clinical breakpoints</strong>
<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 disk 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. Currently, the <code>clinical_breakpoints</code> data set contains 24 breakpoints that can return the value “SDD” instead of “I”.</li>
</ul></li>
<li>
<strong>New forms for MIC plotting and transforming</strong>
<ul><li>New 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>New function <code><a href="../reference/as.mic.html">rescale_mic()</a></code>, which allows users 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 independently to, for instance, compare equality in MIC distributions by rescaling them to the same range first.</li>
</ul></li>
<li>
<strong>Support for Python</strong>
<ul><li>While using R for the heavy lifting, <a href="https://pypi.org/project/AMR/" class="external-link">our AMR Python Package</a> was developed to run the AMR R package natively in Python. The Python package will always have the same version number as the R package, as it is built automatically with every code change.</li>
</ul></li>
<li>
<strong>Support for <code>tidymodels</code></strong>
<ul><li>All antimicrobial selectors (such as <code><a href="../reference/antibiotic_class_selectors.html">aminoglycosides()</a></code> and <code><a href="../reference/antibiotic_class_selectors.html">betalactams()</a></code>) are now supported in <code>tidymodels</code> packages such as <code>recipe</code> and <code>parsnip</code>. See for more info <a href="https://msberends.github.io/AMR/articles/AMR_with_tidymodels.html">our tutorial</a> on using AMR function for predictive modelling.</li>
</ul></li>
<li>
<strong>Other</strong>
<ul><li>New 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 belong to that group.</li>
</ul></li>
</ul></div>
<div class="section level3">
<h3 id="changed-2-1-1-9122">Changed<a class="anchor" aria-label="anchor" href="#changed-2-1-1-9122"></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><a href="../reference/antibiogram.html">antibiogram()</a></code> function
<ul><li>New argument <code>formatting_type</code> to set any of the 12 options for the formatting of all cells. This defaults to <code>10</code>, changing the output of antibiograms to cells with <code>5% (15/300)</code> instead of the previous standard of just <code>5</code>.</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</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>
<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>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 (such as gentamicin-high), the function now always returns a warning that these can be included using <code>only_treatable = FALSE</code>
</li>
<li>All selectors can now be run as a separate command to retrieve a vector of all possible antimicrobials that the selector can select</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>
<li>Sorting of MIC values (using <code><a href="https://rdrr.io/r/base/sort.html" class="external-link">sort()</a></code>) was fixed in the same manner; <code>&lt;0.001</code> now gets sorted before <code>0.001</code>, and <code>&gt;0.001</code> gets sorted after <code>0.001</code>.</li>
<li>Intermediate log2 levels used for MIC plotting are now more common values instead of following a strict dilution range</li>
</ul></li>
<li>Disks of 0 to 5 mm are now allowed, the newly allowed range for disk diffusion (<code><a href="../reference/as.disk.html">as.disk()</a></code>) is now between 0 and 50 mm</li>
<li>Updated <code><a href="../reference/italicise_taxonomy.html">italicise_taxonomy()</a></code> to support HTML output</li>
<li>
<code><a href="../reference/custom_eucast_rules.html">custom_eucast_rules()</a></code> now supports multiple antibiotics and antibiotic groups to be affected by a single rule</li>
<li>
<code><a href="../reference/mo_property.html">mo_info()</a></code> now contains an extra element <code>rank</code> and <code>group_members</code> (with the contents of the new <code><a href="../reference/mo_property.html">mo_group_members()</a></code> function)</li>
<li>Updated all ATC codes from WHOCC</li>
<li>Updated all antibiotic DDDs from WHOCC</li>
<li>Added over 1,500 trade names for antibiotics</li>
<li>Fix for using a manual value for <code>mo_transform</code> in <code><a href="../reference/antibiogram.html">antibiogram()</a></code>
</li>
<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:
<ul><li>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>Genera from the World Health Organizations (WHO) Priority Pathogen List now have the highest prevalence</li>
</ul></li>
<li>Fixed a bug for when <code><a href="../reference/antibiogram.html">antibiogram()</a></code> returns an empty data set</li>
<li>Fixed a bug for <code><a href="../reference/proportion.html">sir_confidence_interval()</a></code> when there are no isolates available</li>
<li>Updated the prevalence calculation to include genera from the World Health Organizations (WHO) Priority Pathogen List</li>
<li>Improved algorithm of <code><a href="../reference/first_isolate.html">first_isolate()</a></code> when using the phenotype-based method, to prioritise records with the highest availability of SIR values</li>
<li>
<code><a href="../reference/plot.html">scale_y_percent()</a></code> can now cope with ranges outside the 0-100% range</li>
<li>MDRO determination (using <code><a href="../reference/mdro.html">mdro()</a></code>)
<ul><li>Implemented the new Dutch national MDRO guideline (SRI-richtlijn BRMO, Nov 2024)</li>
<li>Added arguments <code>esbl</code>, <code>carbapenemase</code>, <code>mecA</code>, <code>mecC</code>, <code>vanA</code>, <code>vanB</code> to denote column names or logical values indicating presence of these genes (or production of their proteins)</li>
</ul></li>
</ul></div>
<div class="section level3">
<h3 id="other-2-1-1-9122">Other<a class="anchor" aria-label="anchor" href="#other-2-1-1-9122"></a></h3>
<ul><li>Greatly improved <code>vctrs</code> integration, a Tidyverse package working in the background for many Tidyverse functions. For users, this means that functions such as <code>dplyr</code>s <code><a href="https://dplyr.tidyverse.org/reference/bind_rows.html" class="external-link">bind_rows()</a></code>, <code><a href="https://dplyr.tidyverse.org/reference/rowwise.html" class="external-link">rowwise()</a></code> and <code><a href="https://dplyr.tidyverse.org/reference/c_across.html" class="external-link">c_across()</a></code> are now supported for e.g. columns of class <code>mic</code>. Despite this, this <code>AMR</code> package is still zero-dependent on any other package, including <code>dplyr</code> and <code>vctrs</code>.</li>
<li>Greatly updated and expanded documentation</li>
<li>Added Larisse Bolton, Jordan Stull, Matthew Saab, and Javier Sanchez as contributors, to thank them for their valuable input</li>
<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-9122">Older Versions<a class="anchor" aria-label="anchor" href="#older-versions-2-1-1-9122"></a></h3>
<p>This changelog only contains changes from AMR v3.0 (October 2024) 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>
</ul></div>
</div>
</main><aside class="col-md-3"><nav id="toc" aria-label="Table of contents"><h2>On this page</h2>
</nav></aside></div>
<footer><div class="pkgdown-footer-left">
<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><a target="_blank" href="https://www.rug.nl" class="external-link"><img src="https://github.com/msberends/AMR/raw/main/pkgdown/assets/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/assets/logo_umcg.svg" style="max-width: 150px;"></a></p>
</div>
</footer></div>
</body></html>