mirror of
https://github.com/msberends/AMR.git
synced 2024-12-25 07:26:12 +01:00
159 lines
20 KiB
HTML
159 lines
20 KiB
HTML
<!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>The AMR Package — AMR • 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="The AMR Package — AMR"><meta name="description" content="Welcome to the AMR package.
|
|
The AMR package is a free and open-source R package with zero dependencies to simplify the analysis and prediction of Antimicrobial Resistance (AMR) and to work with microbial and antimicrobial data and properties, by using evidence-based methods. Our aim is to provide a standard for clean and reproducible AMR data analysis, that can therefore empower epidemiological analyses to continuously enable surveillance and treatment evaluation in any setting. Many different researchers from around the globe are continually helping us to make this a successful and durable project!
|
|
This work was published in the Journal of Statistical Software (Volume 104(3); doi:10.18637/jss.v104.i03
|
|
) and formed the basis of two PhD theses (doi:10.33612/diss.177417131
|
|
and doi:10.33612/diss.192486375
|
|
).
|
|
After installing this package, R knows ~79 000 microorganisms (updated June 2024) and all ~600 antibiotic, antimycotic and antiviral drugs by name and code (including ATC, EARS-Net, ASIARS-Net, PubChem, LOINC and SNOMED CT), and knows all about valid SIR and MIC values. The integral clinical breakpoint guidelines from CLSI and EUCAST are included, even with epidemiological cut-off (ECOFF) values. It supports and can read any data format, including WHONET data. This package works on Windows, macOS and Linux with all versions of R since R-3.0 (April 2013). It was designed to work in any setting, including those with very limited resources. It was created for both routine data analysis and academic research at the Faculty of Medical Sciences of the public University of Groningen, in collaboration with non-profit organisations Certe Medical Diagnostics and Advice Foundation and University Medical Center Groningen.
|
|
The AMR package is available in English, Chinese, Czech, Danish, Dutch, Finnish, French, German, Greek, Italian, Japanese, Norwegian, Polish, Portuguese, Romanian, Russian, Spanish, Swedish, Turkish, and Ukrainian. Antimicrobial drug (group) names and colloquial microorganism names are provided in these languages."><meta property="og:description" content="Welcome to the AMR package.
|
|
The AMR package is a free and open-source R package with zero dependencies to simplify the analysis and prediction of Antimicrobial Resistance (AMR) and to work with microbial and antimicrobial data and properties, by using evidence-based methods. Our aim is to provide a standard for clean and reproducible AMR data analysis, that can therefore empower epidemiological analyses to continuously enable surveillance and treatment evaluation in any setting. Many different researchers from around the globe are continually helping us to make this a successful and durable project!
|
|
This work was published in the Journal of Statistical Software (Volume 104(3); doi:10.18637/jss.v104.i03
|
|
) and formed the basis of two PhD theses (doi:10.33612/diss.177417131
|
|
and doi:10.33612/diss.192486375
|
|
).
|
|
After installing this package, R knows ~79 000 microorganisms (updated June 2024) and all ~600 antibiotic, antimycotic and antiviral drugs by name and code (including ATC, EARS-Net, ASIARS-Net, PubChem, LOINC and SNOMED CT), and knows all about valid SIR and MIC values. The integral clinical breakpoint guidelines from CLSI and EUCAST are included, even with epidemiological cut-off (ECOFF) values. It supports and can read any data format, including WHONET data. This package works on Windows, macOS and Linux with all versions of R since R-3.0 (April 2013). It was designed to work in any setting, including those with very limited resources. It was created for both routine data analysis and academic research at the Faculty of Medical Sciences of the public University of Groningen, in collaboration with non-profit organisations Certe Medical Diagnostics and Advice Foundation and University Medical Center Groningen.
|
|
The AMR package is available in English, Chinese, Czech, Danish, Dutch, Finnish, French, German, Greek, Italian, Japanese, Norwegian, Polish, Portuguese, Romanian, Russian, Spanish, Swedish, Turkish, and Ukrainian. Antimicrobial drug (group) names and colloquial microorganism names are provided in these languages."><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="active 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="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-reference-topic">
|
|
<div class="row">
|
|
<main id="main" class="col-md-9"><div class="page-header">
|
|
<img src="../logo.svg" class="logo" alt=""><h1>The <code>AMR</code> Package</h1>
|
|
<small class="dont-index">Source: <a href="https://github.com/msberends/AMR/blob/main/R/aa_amr-package.R" class="external-link"><code>R/aa_amr-package.R</code></a></small>
|
|
<div class="d-none name"><code>AMR.Rd</code></div>
|
|
</div>
|
|
|
|
<div class="ref-description section level2">
|
|
<p>Welcome to the <code>AMR</code> package.</p>
|
|
<p>The <code>AMR</code> package is a <a href="https://msberends.github.io/AMR/#copyright">free and open-source</a> R package with <a href="https://en.wikipedia.org/wiki/Dependency_hell" class="external-link">zero dependencies</a> to simplify the analysis and prediction of Antimicrobial Resistance (AMR) and to work with microbial and antimicrobial data and properties, by using evidence-based methods. <strong>Our aim is to provide a standard</strong> for clean and reproducible AMR data analysis, that can therefore empower epidemiological analyses to continuously enable surveillance and treatment evaluation in any setting. <a href="https://msberends.github.io/AMR/authors.html">Many different researchers</a> from around the globe are continually helping us to make this a successful and durable project!</p>
|
|
<p>This work was published in the Journal of Statistical Software (Volume 104(3); <a href="https://doi.org/10.18637/jss.v104.i03" class="external-link">doi:10.18637/jss.v104.i03</a>
|
|
) and formed the basis of two PhD theses (<a href="https://doi.org/10.33612/diss.177417131" class="external-link">doi:10.33612/diss.177417131</a>
|
|
and <a href="https://doi.org/10.33612/diss.192486375" class="external-link">doi:10.33612/diss.192486375</a>
|
|
).</p>
|
|
<p>After installing this package, R knows <a href="https://msberends.github.io/AMR/reference/microorganisms.html"><strong>~79 000 microorganisms</strong></a> (updated June 2024) and all <a href="https://msberends.github.io/AMR/reference/antibiotics.html"><strong>~600 antibiotic, antimycotic and antiviral drugs</strong></a> by name and code (including ATC, EARS-Net, ASIARS-Net, PubChem, LOINC and SNOMED CT), and knows all about valid SIR and MIC values. The integral clinical breakpoint guidelines from CLSI and EUCAST are included, even with epidemiological cut-off (ECOFF) values. It supports and can read any data format, including WHONET data. This package works on Windows, macOS and Linux with all versions of R since R-3.0 (April 2013). <strong>It was designed to work in any setting, including those with very limited resources</strong>. It was created for both routine data analysis and academic research at the Faculty of Medical Sciences of the public <a href="https://www.rug.nl" class="external-link">University of Groningen</a>, in collaboration with non-profit organisations <a href="https://www.certe.nl" class="external-link">Certe Medical Diagnostics and Advice Foundation</a> and <a href="https://www.umcg.nl" class="external-link">University Medical Center Groningen</a>.</p>
|
|
<p>The <code>AMR</code> package is available in English, Chinese, Czech, Danish, Dutch, Finnish, French, German, Greek, Italian, Japanese, Norwegian, Polish, Portuguese, Romanian, Russian, Spanish, Swedish, Turkish, and Ukrainian. Antimicrobial drug (group) names and colloquial microorganism names are provided in these languages.</p>
|
|
</div>
|
|
|
|
|
|
<div class="section level2">
|
|
<h2 id="source">Source<a class="anchor" aria-label="anchor" href="#source"></a></h2>
|
|
<p>To cite AMR in publications use:</p>
|
|
<p>Berends MS, Luz CF, Friedrich AW, Sinha BNM, Albers CJ, Glasner C (2022). "AMR: An R Package for Working with Antimicrobial Resistance Data." <em>Journal of Statistical Software</em>, <em>104</em>(3), 1-31. <a href="https://doi.org/10.18637/jss.v104.i03" class="external-link">doi:10.18637/jss.v104.i03</a></p>
|
|
<p>A BibTeX entry for LaTeX users is:</p>
|
|
<div class="sourceCode"><pre><code>
|
|
@Article{,
|
|
title = {{AMR}: An {R} Package for Working with Antimicrobial Resistance Data},
|
|
author = {Matthijs S. Berends and Christian F. Luz and Alexander W. Friedrich and Bhanu N. M. Sinha and Casper J. Albers and Corinna Glasner},
|
|
journal = {Journal of Statistical Software},
|
|
year = {2022},
|
|
volume = {104},
|
|
number = {3},
|
|
pages = {1--31},
|
|
doi = {10.18637/jss.v104.i03},
|
|
}
|
|
</code></pre></div>
|
|
|
|
</div>
|
|
<div class="section level2">
|
|
<h2 id="reference-data-publicly-available">Reference Data Publicly Available<a class="anchor" aria-label="anchor" href="#reference-data-publicly-available"></a></h2>
|
|
|
|
|
|
<p>All data sets in this <code>AMR</code> package (about microorganisms, antibiotics, SIR interpretation, EUCAST rules, etc.) are publicly and freely available for download in the following formats: R, MS Excel, Apache Feather, Apache Parquet, SPSS, and Stata. We also provide tab-separated plain text files that are machine-readable and suitable for input in any software program, such as laboratory information systems. Please visit <a href="https://msberends.github.io/AMR/articles/datasets.html">our website for the download links</a>. The actual files are of course available on <a href="https://github.com/msberends/AMR/tree/main/data-raw" class="external-link">our GitHub repository</a>.</p>
|
|
</div>
|
|
<div class="section level2">
|
|
<h2 id="see-also">See also<a class="anchor" aria-label="anchor" href="#see-also"></a></h2>
|
|
<div class="dont-index"><p>Useful links:</p><ul><li><p><a href="https://msberends.github.io/AMR/">https://msberends.github.io/AMR/</a></p></li>
|
|
<li><p><a href="https://github.com/msberends/AMR" class="external-link">https://github.com/msberends/AMR</a></p></li>
|
|
<li><p>Report bugs at <a href="https://github.com/msberends/AMR/issues" class="external-link">https://github.com/msberends/AMR/issues</a></p></li>
|
|
</ul></div>
|
|
</div>
|
|
<div class="section level2">
|
|
<h2 id="author">Author<a class="anchor" aria-label="anchor" href="#author"></a></h2>
|
|
<p><strong>Maintainer</strong>: Matthijs S. Berends <a href="mailto:m.s.berends@umcg.nl">m.s.berends@umcg.nl</a> (<a href="https://orcid.org/0000-0001-7620-1800" class="external-link">ORCID</a>)</p>
|
|
<p>Authors:</p><ul><li><p>Dennis Souverein (<a href="https://orcid.org/0000-0003-0455-0336" class="external-link">ORCID</a>) [contributor]</p></li>
|
|
<li><p>Erwin E. A. Hassing [contributor]</p></li>
|
|
</ul><p>Other contributors:</p><ul><li><p>Andrew P. Norgan (<a href="https://orcid.org/0000-0002-2955-2066" class="external-link">ORCID</a>) [contributor]</p></li>
|
|
<li><p>Anita Williams (<a href="https://orcid.org/0000-0002-5295-8451" class="external-link">ORCID</a>) [contributor]</p></li>
|
|
<li><p>Annick Lenglet (<a href="https://orcid.org/0000-0003-2013-8405" class="external-link">ORCID</a>) [contributor]</p></li>
|
|
<li><p>Anthony Underwood (<a href="https://orcid.org/0000-0002-8547-4277" class="external-link">ORCID</a>) [contributor]</p></li>
|
|
<li><p>Anton Mymrikov [contributor]</p></li>
|
|
<li><p>Bart C. Meijer [contributor]</p></li>
|
|
<li><p>Christian F. Luz (<a href="https://orcid.org/0000-0001-5809-5995" class="external-link">ORCID</a>) [contributor]</p></li>
|
|
<li><p>Dmytro Mykhailenko [contributor]</p></li>
|
|
<li><p>Eric H. L. C. M. Hazenberg [contributor]</p></li>
|
|
<li><p>Gwen Knight (<a href="https://orcid.org/0000-0002-7263-9896" class="external-link">ORCID</a>) [contributor]</p></li>
|
|
<li><p>Jason Stull (<a href="https://orcid.org/0000-0002-9028-8153" class="external-link">ORCID</a>) [contributor]</p></li>
|
|
<li><p>Javier Sanchez (<a href="https://orcid.org/0000-0003-2605-8094" class="external-link">ORCID</a>) [contributor]</p></li>
|
|
<li><p>Jonas Salm [contributor]</p></li>
|
|
<li><p>Judith M. Fonville [contributor]</p></li>
|
|
<li><p>Larisse Bolton (<a href="https://orcid.org/0000-0001-7879-2173" class="external-link">ORCID</a>) [contributor]</p></li>
|
|
<li><p>Matthew Saab [contributor]</p></li>
|
|
<li><p>Peter Dutey-Magni (<a href="https://orcid.org/0000-0002-8942-9836" class="external-link">ORCID</a>) [contributor]</p></li>
|
|
<li><p>Rogier P. Schade [contributor]</p></li>
|
|
<li><p>Sofia Ny (<a href="https://orcid.org/0000-0002-2017-1363" class="external-link">ORCID</a>) [contributor]</p></li>
|
|
<li><p>Alex W. Friedrich (<a href="https://orcid.org/0000-0003-4881-038X" class="external-link">ORCID</a>) [thesis advisor]</p></li>
|
|
<li><p>Bhanu N. M. Sinha (<a href="https://orcid.org/0000-0003-1634-0010" class="external-link">ORCID</a>) [thesis advisor]</p></li>
|
|
<li><p>Casper J. Albers (<a href="https://orcid.org/0000-0002-9213-6743" class="external-link">ORCID</a>) [thesis advisor]</p></li>
|
|
<li><p>Corinna Glasner (<a href="https://orcid.org/0000-0003-1241-1328" class="external-link">ORCID</a>) [thesis advisor]</p></li>
|
|
</ul></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>
|
|
|