Built site for AMR@2.1.1.9084: 88740b6

.Rbuildignore

@@ -1,27 +0,0 @@
-^.*\.Rproj$
-^\.gitlab-ci\.R$
-^\.gitlab-ci\.yml$
-^\.Renviron$
-^\.Rprofile$
-^\.Rproj\.user$
-^\.travis\.yml$
-^\.zenodo\.json$
-^_noinclude$
-^_pkgdown\.yml$
-^appveyor\.yml$
-^codecov\.yml$
-^cran-comments\.md$
-^CRAN-RELEASE$
-^doc$
-^docs$
-^git_.*\.sh$
-^index\.md$
-^installed_deps$
-^Meta$
-^pkgdown$
-^public$
-^data-raw$
-^\.lintr$
-^vignettes/benchmark.*
-^vignettes/SPSS.*
-^tests/appveyor$

.gitignore

@@ -1,24 +0,0 @@
-Meta
-doc
-.Renviron
-.Rproj.user
-.Rhistory
-.RData
-.Ruserdata
-AMR.Rproj
-tests/testthat/Rplots.pdf
-inst/doc
-/src/*.o
-/src/*.o-*
-/src/*.d
-/src/*.so
-_noinclude
-*.dll
-vignettes/*.R
-.DS_Store
-.Rprofile
-^CRAN-RELEASE$
-packrat/lib*/
-packrat/src/
-data-raw/taxon.tab
-data-raw/DSMZ_bactnames.xlsx

.gitlab-ci.R

@@ -1,54 +0,0 @@
-# ==================================================================== #
-# TITLE                                                                #
-# Antimicrobial Resistance (AMR) Analysis                              #
-#                                                                      #
-# SOURCE                                                               #
-# https://gitlab.com/msberends/AMR                                     #
-#                                                                      #
-# LICENCE                                                              #
-# (c) 2019 Berends MS (m.s.berends@umcg.nl), Luz CF (c.f.luz@umcg.nl)  #
-#                                                                      #
-# This R package is free software; you can freely use and distribute   #
-# it for both personal and commercial purposes under the terms of the  #
-# GNU General Public License version 2.0 (GNU GPL-2), as published by  #
-# the Free Software Foundation.                                        #
-#                                                                      #
-# This R package was created for academic research and was publicly    #
-# released in the hope that it will be useful, but it comes WITHOUT    #
-# ANY WARRANTY OR LIABILITY.                                           #
-# Visit our website for more info: https://msberends.gitlab.io/AMR.    #
-# ==================================================================== #
-
-install_if_needed <- function(pkg, repos, quiet) {
-  package_path <- find.package(pkg, quiet = quiet)
-  if (length(package_path) == 0) {
-    message("NOTE: pkg ", pkg, " missing, installing...")
-    install.packages(pkg, repos = repos, quiet = quiet)
-  }
-}
-
-gl_update_pkg_all <- function(repos = "https://cran.rstudio.com",
-                              quiet = TRUE,
-                              install_pkgdown = FALSE,
-                              install_lintr = FALSE) {
-  # update existing
-  update.packages(ask = FALSE, repos = repos, quiet = quiet)
-
-  install_if_needed(pkg = "devtools", repos = repos, quiet = quiet)
-  if (install_pkgdown == TRUE) {
-    install_if_needed(pkg = "pkgdown", repos = repos, quiet = quiet)
-  }
-  if (install_lintr == TRUE) {
-    install_if_needed(pkg = "lintr", repos = repos, quiet = quiet)
-  }
-  install_if_needed(pkg = "cleaner", repos = repos, quiet = quiet)
-  
-  devtools::install_dev_deps(repos = repos, quiet = quiet, upgrade = TRUE)
-
-  cat("INSTALLED:\n")
-  instld <- as.data.frame(installed.packages())
-  rownames(instld) <- NULL
-  print(instld[, c("Package", "Version")])
-
-  return(invisible(TRUE))
-}

.gitlab-ci.yml

@@ -1,151 +0,0 @@
-# ==================================================================== #
-# TITLE                                                                #
-# Antimicrobial Resistance (AMR) Analysis                              #
-#                                                                      #
-# SOURCE                                                               #
-# https://gitlab.com/msberends/AMR                                     #
-#                                                                      #
-# LICENCE                                                              #
-# (c) 2019 Berends MS (m.s.berends@umcg.nl), Luz CF (c.f.luz@umcg.nl)  #
-#                                                                      #
-# This R package is free software; you can freely use and distribute   #
-# it for both personal and commercial purposes under the terms of the  #
-# GNU General Public License version 2.0 (GNU GPL-2), as published by  #
-# the Free Software Foundation.                                        #
-#                                                                      #
-# This R package was created for academic research and was publicly    #
-# released in the hope that it will be useful, but it comes WITHOUT    #
-# ANY WARRANTY OR LIABILITY.                                           #
-# Visit our website for more info: https://msberends.gitlab.io/AMR.    #
-# ==================================================================== #
-
-# to do a full CRAN check with R-Hub:
-# chck <- rhub::check(devtools::build(), platform = c('debian-clang-devel', 'debian-gcc-devel', 'fedora-clang-devel', 'fedora-gcc-devel', 'windows-x86_64-devel', 'debian-gcc-patched', 'solaris-x86-patched', 'debian-gcc-release', 'windows-x86_64-release', 'macos-elcapitan-release', 'windows-x86_64-oldrel'))
-
-stages:
-  - check
-  - lint
-  - coverage
-  - website
-  
-image: rocker/r-base
-
-before_script:
-  - apt-get update -qq  --allow-releaseinfo-change
-  # install dependencies for packages
-  - apt-get install -y wget locales libxml2-dev libssl-dev libcurl4-openssl-dev zlib1g-dev > /dev/null
-  # recent pandoc
-  - wget --quiet https://github.com/jgm/pandoc/releases/download/2.7.3/pandoc-2.7.3-1-amd64.deb
-  - dpkg -i pandoc*.deb
-  - rm pandoc*.deb
-  # set R system language
-  - echo "LC_ALL=en_US.UTF-8" >> /etc/environment
-  - echo "en_US.UTF-8 UTF-8" >> /etc/locale.gen
-  - echo "LANG=en_US.UTF-8" > /etc/locale.conf
-  - locale-gen
-  # cache R packages
-  - mkdir -p installed_deps
-  - echo 'R_LIBS="installed_deps"' > .Renviron
-  - echo 'R_LIBS_USER="installed_deps"' >> .Renviron
-  - echo 'R_LIBS_SITE="installed_deps"' >> .Renviron
-  # set language
-  - echo 'LANGUAGE="en_US.utf8"' >> .Renviron
-  - echo 'LANG="en_US.utf8"' >> .Renviron
-  - echo 'LANGUAGE="en_US.utf8"' > ~/.Renviron
-
-R-release:
-  stage: check
-  allow_failure: false
-  script:
-    - Rscript -e 'sessionInfo()'
-    # install missing and outdated packages
-    - Rscript -e 'source(".gitlab-ci.R"); gl_update_pkg_all(repos = "https://cran.rstudio.com", quiet = TRUE, install_pkgdown = TRUE,  install_lintr = TRUE)'
-    # remove vignettes folder and get VignetteBuilder field out of DESCRIPTION file
-    - rm -rf vignettes
-    - Rscript -e 'd <- read.dcf("DESCRIPTION"); d[, colnames(d) == "VignetteBuilder"] <- NA; write.dcf(d, "DESCRIPTION")'
-    # build package
-    - R CMD build . --no-build-vignettes --no-manual
-    - PKG_FILE_NAME=$(ls -1t *.tar.gz | head -n 1)
-    - Rscript -e 'Sys.setenv(NOT_CRAN = "true")'
-    - R CMD check "${PKG_FILE_NAME}" --no-build-vignettes --no-manual --as-cran
-  artifacts:
-    when: always
-    paths:
-      - '*.Rcheck/*'
-    expire_in: '1 month'
-  cache:
-    key: r350
-    paths:
-      - installed_deps/
-
-R-devel:
-  stage: check
-  image: rocker/r-devel
-  allow_failure: false
-  script:
-    - Rscriptdevel -e 'sessionInfo()'
-    # install missing and outdated packages
-    - Rscriptdevel -e 'source(".gitlab-ci.R"); gl_update_pkg_all(repos = "https://cran.rstudio.com", quiet = TRUE)'
-    # remove vignettes folder and get VignetteBuilder field out of DESCRIPTION file
-    - rm -rf vignettes
-    - Rscriptdevel -e 'd <- read.dcf("DESCRIPTION"); d[, colnames(d) == "VignetteBuilder"] <- NA; write.dcf(d, "DESCRIPTION")'
-    # build package
-    - Rdevel CMD build . --no-build-vignettes --no-manual
-    - PKG_FILE_NAME=$(ls -1t *.tar.gz | head -n 1)
-    - Rscript -e 'Sys.setenv(NOT_CRAN = "true")'
-    - Rdevel CMD check "${PKG_FILE_NAME}" --no-build-vignettes --no-manual --as-cran
-  artifacts:
-    when: always
-    paths:
-      - '*.Rcheck/*'
-    expire_in: '1 month'
-  cache:
-    key: r360
-    paths:
-      - installed_deps/
-
-lintr:
-  stage: lint
-  allow_failure: true
-  when: on_success
-  cache:
-    key: r350
-    paths:
-      - installed_deps/
-    policy: pull # no uploading after run
-  only:
-    - premaster
-    - master
-  script:
-    # check all syntax with lintr
-    - Rscript -e 'lintr::lint_package()'
-
-codecovr:
-  stage: coverage
-  allow_failure: true
-  when: on_success
-  cache:
-    key: r350
-    paths:
-      - installed_deps/
-    policy: pull # no uploading after run
-  only:
-    - premaster
-    - master
-  script:
-    - apt-get install --yes git
-    # codecov token is set in https://gitlab.com/msberends/AMR/settings/ci_cd
-    # Sys.setenv(NOT_CRAN = 'true'), because otherwise skip_on_cran() will be applied on Covr too, resulting in extremely low coverage percentages
-    - Rscript -e "Sys.setenv(NOT_CRAN = 'true'); cc <- covr::package_coverage(line_exclusions = list('R/atc_online.R', 'R/mo_history.R', 'R/mo_source.R', 'R/resistance_predict.R')); covr::codecov(coverage = cc, token = '$codecov'); cat('Code coverage:', covr::percent_coverage(cc))"
-  coverage: '/Code coverage: \d+\.\d+/'
-
-pages:
-  stage: website
-  when: always
-  only:
-    - master
-  script:
-    - mv docs public
-  artifacts:
-    paths:
-      - public

.lintr

@@ -1 +0,0 @@
-linters: with_defaults(line_length_linter = NULL, trailing_whitespace_linter = NULL, object_name_linter = NULL, cyclocomp_linter = NULL, object_usage_linter = NULL, object_length_linter(length = 50L))

.nojekyll

@@ -0,0 +1 @@
+

404.html

@@ -0,0 +1,100 @@
+<!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>Page not found (404) • AMR (for R)</title>
+<!-- favicons --><link rel="icon" type="image/png" sizes="16x16" href="https://msberends.github.io/AMR/favicon-16x16.png">
+<link rel="icon" type="image/png" sizes="32x32" href="https://msberends.github.io/AMR/favicon-32x32.png">
+<link rel="apple-touch-icon" type="image/png" sizes="180x180" href="https://msberends.github.io/AMR/apple-touch-icon.png">
+<link rel="apple-touch-icon" type="image/png" sizes="120x120" href="https://msberends.github.io/AMR/apple-touch-icon-120x120.png">
+<link rel="apple-touch-icon" type="image/png" sizes="76x76" href="https://msberends.github.io/AMR/apple-touch-icon-76x76.png">
+<link rel="apple-touch-icon" type="image/png" sizes="60x60" href="https://msberends.github.io/AMR/apple-touch-icon-60x60.png">
+<script src="https://msberends.github.io/AMR/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="https://msberends.github.io/AMR/deps/bootstrap-5.3.1/bootstrap.min.css" rel="stylesheet">
+<script src="https://msberends.github.io/AMR/deps/bootstrap-5.3.1/bootstrap.bundle.min.js"></script><link href="https://msberends.github.io/AMR/deps/Lato-0.4.9/font.css" rel="stylesheet">
+<link href="https://msberends.github.io/AMR/deps/Fira_Code-0.4.9/font.css" rel="stylesheet">
+<link href="https://msberends.github.io/AMR/deps/font-awesome-6.4.2/css/all.min.css" rel="stylesheet">
+<link href="https://msberends.github.io/AMR/deps/font-awesome-6.4.2/css/v4-shims.min.css" rel="stylesheet">
+<script src="https://msberends.github.io/AMR/deps/headroom-0.11.0/headroom.min.js"></script><script src="https://msberends.github.io/AMR/deps/headroom-0.11.0/jQuery.headroom.min.js"></script><script src="https://msberends.github.io/AMR/deps/bootstrap-toc-1.0.1/bootstrap-toc.min.js"></script><script src="https://msberends.github.io/AMR/deps/clipboard.js-2.0.11/clipboard.min.js"></script><script src="https://msberends.github.io/AMR/deps/search-1.0.0/autocomplete.jquery.min.js"></script><script src="https://msberends.github.io/AMR/deps/search-1.0.0/fuse.min.js"></script><script src="https://msberends.github.io/AMR/deps/search-1.0.0/mark.min.js"></script><!-- pkgdown --><script src="https://msberends.github.io/AMR/pkgdown.js"></script><link href="https://msberends.github.io/AMR/extra.css" rel="stylesheet">
+<script src="https://msberends.github.io/AMR/extra.js"></script><meta property="og:title" content="Page not found (404)">
+<meta property="og:image" content="https://msberends.github.io/AMR/logo.svg">
+</head>
+<body>
+    <a href="https://msberends.github.io/AMR/#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="https://msberends.github.io/AMR/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.9084</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="https://msberends.github.io/AMR/articles/AMR.html"><span class="fa fa-directions"></span> Conduct AMR Analysis</a></li>
+    <li><a class="dropdown-item" href="https://msberends.github.io/AMR/reference/antibiogram.html"><span class="fa fa-file-prescription"></span> Generate Antibiogram (Trad./Syndromic/WISCA)</a></li>
+    <li><a class="dropdown-item" href="https://msberends.github.io/AMR/articles/resistance_predict.html"><span class="fa fa-dice"></span> Predict Antimicrobial Resistance</a></li>
+    <li><a class="dropdown-item" href="https://msberends.github.io/AMR/articles/datasets.html"><span class="fa fa-database"></span> Download Data Sets for Own Use</a></li>
+    <li><a class="dropdown-item" href="https://msberends.github.io/AMR/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="https://msberends.github.io/AMR/articles/PCA.html"><span class="fa fa-compress"></span> Conduct Principal Component Analysis for AMR</a></li>
+    <li><a class="dropdown-item" href="https://msberends.github.io/AMR/articles/MDR.html"><span class="fa fa-skull-crossbones"></span> Determine Multi-Drug Resistance (MDR)</a></li>
+    <li><a class="dropdown-item" href="https://msberends.github.io/AMR/articles/WHONET.html"><span class="fa fa-globe-americas"></span> Work with WHONET Data</a></li>
+    <li><a class="dropdown-item" href="https://msberends.github.io/AMR/articles/EUCAST.html"><span class="fa fa-exchange-alt"></span> Apply Eucast Rules</a></li>
+    <li><a class="dropdown-item" href="https://msberends.github.io/AMR/reference/mo_property.html"><span class="fa fa-bug"></span> Get Taxonomy of a Microorganism</a></li>
+    <li><a class="dropdown-item" href="https://msberends.github.io/AMR/reference/ab_property.html"><span class="fa fa-capsules"></span> Get Properties of an Antibiotic Drug</a></li>
+    <li><a class="dropdown-item" href="https://msberends.github.io/AMR/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="https://msberends.github.io/AMR/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="https://msberends.github.io/AMR/reference/index.html"><span class="fa fa-book-open"></span> Manual</a></li>
+<li class="nav-item"><a class="nav-link" href="https://msberends.github.io/AMR/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="https://msberends.github.io/AMR/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-title-body">
+<div class="row">
+  <main id="main" class="col-md-9"><div class="page-header">
+      <img src="https://msberends.github.io/AMR/logo.svg" class="logo" alt=""><h1>Page not found (404)</h1>
+
+    </div>
+
+Content not found. Please use links in the navbar.
+
+  </main>
+</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>

DESCRIPTION

@@ -1,67 +0,0 @@
-Package: AMR
-Version: 0.9.0
-Date: 2019-11-29
-Title: Antimicrobial Resistance Analysis
-Authors@R: c(
-    person(role = c("aut", "cre"), 
-           family = "Berends", given = c("Matthijs", "S."), email = "m.s.berends@umcg.nl", comment = c(ORCID = "0000-0001-7620-1800")),
-    person(role = c("aut", "ctb"),
-           family = "Luz", given = c("Christian", "F."), email = "c.f.luz@umcg.nl", comment = c(ORCID = "0000-0001-5809-5995")),
-    person(role = c("aut", "ths"),
-           family = "Friedrich", given = c("Alex", "W."), email = "alex.friedrich@umcg.nl", comment = c(ORCID = "0000-0003-4881-038X")),
-    person(role = c("aut", "ths"),
-           family = "Sinha", given = c("Bhanu", "N.", "M."), email = "b.sinha@umcg.nl", comment = c(ORCID = "0000-0003-1634-0010")),
-    person(role = c("aut", "ths"),
-           family = "Albers", given = c("Casper", "J."), email = "c.j.albers@rug.nl", comment = c(ORCID = "0000-0002-9213-6743")),
-    person(role = c("aut", "ths"),
-           family = "Glasner", given = "Corinna", email = "c.glasner@umcg.nl", comment = c(ORCID = "0000-0003-1241-1328")),
-    person(role = "ctb",
-           family = "Fonville", given = c("Judith", "M."), email = "j.fonville@pamm.nl"),
-    person(role = "ctb",
-           family = "Hassing", given = c("Erwin", "E.", "A."), email = "e.hassing@certe.nl"),
-    person(role = "ctb",
-           family = "Hazenberg", given = c("Eric", "H.", "L.", "C.", "M."), email = "e.hazenberg@jbz.nl"),
-    person(role = "ctb",
-           family = "Lenglet", given = "Annick", email = "annick.lenglet@amsterdam.msf.org"),
-    person(role = "ctb",
-           family = "Meijer", given = c("Bart", "C."), email = "b.meijerg@certe.nl"),
-    person(role = "ctb",
-           family = "Ny", given = "Sofia", email = "sofia.ny@folkhalsomyndigheten.se"),
-    person(role = "ctb",
-           family = "Souverein", given = "Dennis", email = "d.souvereing@streeklabhaarlem.nl"))
-Description: Functions to simplify the analysis and prediction of Antimicrobial 
-    Resistance (AMR) and to work with microbial and antimicrobial properties by
-    using evidence-based methods, like those defined by Leclercq et al. (2013) 
-    <doi:10.1111/j.1469-0691.2011.03703.x> and the Clinical and Laboratory 
-    Standards Institute (2014) <isbn: 1-56238-899-1>.
-Depends:
-    R (>= 3.1.0)
-Imports:
-    backports,
-    cleaner,
-    crayon (>= 1.3.0),
-    data.table (>= 1.9.0),
-    dplyr (>= 0.7.0),
-    ggplot2,
-    knitr (>= 1.0.0),
-    microbenchmark,
-    pillar,
-    rlang (>= 0.3.1),
-    tidyr (>= 1.0.0)
-Suggests:
-    covr (>= 3.0.1),
-    curl,
-    readxl,
-    rmarkdown,
-    rstudioapi,
-    rvest (>= 0.3.2),
-    testthat (>= 1.0.2),
-    xml2 (>= 1.0.0)
-VignetteBuilder: knitr
-URL: https://msberends.gitlab.io/AMR, https://gitlab.com/msberends/AMR
-BugReports: https://gitlab.com/msberends/AMR/issues
-License: GPL-2 | file LICENSE
-Encoding: UTF-8
-LazyData: true
-RoxygenNote: 7.0.1
-Roxygen: list(markdown = TRUE)

LICENSE-text.html

@@ -1,7 +1,55 @@
-GNU GENERAL PUBLIC LICENSE
+<!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>License • 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.4.2/css/all.min.css" rel="stylesheet"><link href="deps/font-awesome-6.4.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="License"><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.9084</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="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="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-title-body">
+<div class="row">
+  <main id="main" class="col-md-9"><div class="page-header">
+      <img src="logo.svg" class="logo" alt=""><h1>License</h1>
+
+    </div>
+
+<pre>GNU GENERAL PUBLIC LICENSE
 Version 2, June 1991
 
-Copyright (C) 1989, 1991 Free Software Foundation, Inc., <http://fsf.org/>
+Copyright (C) 1989, 1991 Free Software Foundation, Inc., &lt;http://fsf.org/&gt;
   51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 Everyone is permitted to copy and distribute verbatim copies
 of this license document, but changing it is not allowed.
@@ -246,3 +294,24 @@ PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
 POSSIBILITY OF SUCH DAMAGES.
 
 END OF TERMS AND CONDITIONS
+</pre>
+
+  </main></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>
+

NAMESPACE

@@ -1,331 +0,0 @@
-# Generated by roxygen2: do not edit by hand
-
-S3method("[",ab)
-S3method("[",mo)
-S3method("[<-",ab)
-S3method("[<-",mo)
-S3method("[[",ab)
-S3method("[[",mo)
-S3method("[[<-",ab)
-S3method("[[<-",mo)
-S3method(as.data.frame,ab)
-S3method(as.data.frame,mo)
-S3method(as.double,mic)
-S3method(as.integer,mic)
-S3method(as.numeric,mic)
-S3method(as.rsi,data.frame)
-S3method(as.rsi,default)
-S3method(as.rsi,disk)
-S3method(as.rsi,mic)
-S3method(barplot,mic)
-S3method(barplot,rsi)
-S3method(c,ab)
-S3method(c,mo)
-S3method(droplevels,mic)
-S3method(droplevels,rsi)
-S3method(format,bug_drug_combinations)
-S3method(freq,mo)
-S3method(freq,rsi)
-S3method(kurtosis,data.frame)
-S3method(kurtosis,default)
-S3method(kurtosis,matrix)
-S3method(pillar_shaft,ab)
-S3method(pillar_shaft,disk)
-S3method(pillar_shaft,mic)
-S3method(pillar_shaft,mo)
-S3method(pillar_shaft,rsi)
-S3method(plot,mic)
-S3method(plot,resistance_predict)
-S3method(plot,rsi)
-S3method(print,ab)
-S3method(print,bug_drug_combinations)
-S3method(print,catalogue_of_life_version)
-S3method(print,disk)
-S3method(print,mic)
-S3method(print,mo)
-S3method(print,mo_renamed)
-S3method(print,mo_uncertainties)
-S3method(print,rsi)
-S3method(skewness,data.frame)
-S3method(skewness,default)
-S3method(skewness,matrix)
-S3method(summary,mic)
-S3method(summary,mo)
-S3method(summary,rsi)
-S3method(type_sum,ab)
-S3method(type_sum,disk)
-S3method(type_sum,mic)
-S3method(type_sum,mo)
-S3method(type_sum,rsi)
-export("%like%")
-export("%like_case%")
-export(ab_atc)
-export(ab_atc_group1)
-export(ab_atc_group2)
-export(ab_cid)
-export(ab_ddd)
-export(ab_group)
-export(ab_info)
-export(ab_name)
-export(ab_property)
-export(ab_synonyms)
-export(ab_tradenames)
-export(age)
-export(age_groups)
-export(anti_join_microorganisms)
-export(as.ab)
-export(as.disk)
-export(as.mic)
-export(as.mo)
-export(as.rsi)
-export(atc_online_ddd)
-export(atc_online_groups)
-export(atc_online_property)
-export(availability)
-export(brmo)
-export(bug_drug_combinations)
-export(catalogue_of_life_version)
-export(clear_mo_history)
-export(count_I)
-export(count_IR)
-export(count_R)
-export(count_S)
-export(count_SI)
-export(count_all)
-export(count_df)
-export(count_resistant)
-export(count_susceptible)
-export(eucast_exceptional_phenotypes)
-export(eucast_rules)
-export(facet_rsi)
-export(filter_1st_cephalosporins)
-export(filter_2nd_cephalosporins)
-export(filter_3rd_cephalosporins)
-export(filter_4th_cephalosporins)
-export(filter_5th_cephalosporins)
-export(filter_ab_class)
-export(filter_aminoglycosides)
-export(filter_carbapenems)
-export(filter_cephalosporins)
-export(filter_first_isolate)
-export(filter_first_weighted_isolate)
-export(filter_fluoroquinolones)
-export(filter_glycopeptides)
-export(filter_macrolides)
-export(filter_tetracyclines)
-export(first_isolate)
-export(freq)
-export(full_join_microorganisms)
-export(g.test)
-export(geom_rsi)
-export(get_locale)
-export(get_mo_source)
-export(ggplot_rsi)
-export(ggplot_rsi_predict)
-export(guess_ab_col)
-export(inner_join_microorganisms)
-export(is.ab)
-export(is.disk)
-export(is.mic)
-export(is.mo)
-export(is.rsi)
-export(is.rsi.eligible)
-export(key_antibiotics)
-export(key_antibiotics_equal)
-export(kurtosis)
-export(labels_rsi_count)
-export(left_join_microorganisms)
-export(like)
-export(mdr_cmi2012)
-export(mdr_tb)
-export(mdro)
-export(mo_authors)
-export(mo_class)
-export(mo_failures)
-export(mo_family)
-export(mo_fullname)
-export(mo_genus)
-export(mo_gramstain)
-export(mo_info)
-export(mo_kingdom)
-export(mo_name)
-export(mo_order)
-export(mo_phylum)
-export(mo_property)
-export(mo_rank)
-export(mo_ref)
-export(mo_renamed)
-export(mo_shortname)
-export(mo_species)
-export(mo_subspecies)
-export(mo_synonyms)
-export(mo_taxonomy)
-export(mo_type)
-export(mo_uncertainties)
-export(mo_url)
-export(mo_year)
-export(mrgn)
-export(n_rsi)
-export(p.symbol)
-export(p_symbol)
-export(portion_I)
-export(portion_IR)
-export(portion_R)
-export(portion_S)
-export(portion_SI)
-export(portion_df)
-export(proportion_I)
-export(proportion_IR)
-export(proportion_R)
-export(proportion_S)
-export(proportion_SI)
-export(proportion_df)
-export(read.4D)
-export(resistance)
-export(resistance_predict)
-export(right_join_microorganisms)
-export(rsi_df)
-export(rsi_predict)
-export(scale_rsi_colours)
-export(scale_type.ab)
-export(scale_type.mo)
-export(scale_y_percent)
-export(semi_join_microorganisms)
-export(set_mo_source)
-export(skewness)
-export(susceptibility)
-export(theme_rsi)
-exportMethods("[.ab")
-exportMethods("[.mo")
-exportMethods("[<-.ab")
-exportMethods("[<-.mo")
-exportMethods("[[.ab")
-exportMethods("[[.mo")
-exportMethods("[[<-.ab")
-exportMethods("[[<-.mo")
-exportMethods(as.data.frame.ab)
-exportMethods(as.data.frame.mo)
-exportMethods(as.double.mic)
-exportMethods(as.integer.mic)
-exportMethods(as.numeric.mic)
-exportMethods(barplot.mic)
-exportMethods(barplot.rsi)
-exportMethods(c.ab)
-exportMethods(c.mo)
-exportMethods(droplevels.mic)
-exportMethods(droplevels.rsi)
-exportMethods(format.bug_drug_combinations)
-exportMethods(freq.mo)
-exportMethods(freq.rsi)
-exportMethods(kurtosis)
-exportMethods(kurtosis.data.frame)
-exportMethods(kurtosis.default)
-exportMethods(kurtosis.matrix)
-exportMethods(plot.mic)
-exportMethods(plot.rsi)
-exportMethods(print.ab)
-exportMethods(print.bug_drug_combinations)
-exportMethods(print.catalogue_of_life_version)
-exportMethods(print.disk)
-exportMethods(print.mic)
-exportMethods(print.mo)
-exportMethods(print.mo_renamed)
-exportMethods(print.mo_uncertainties)
-exportMethods(print.rsi)
-exportMethods(scale_type.ab)
-exportMethods(scale_type.mo)
-exportMethods(skewness)
-exportMethods(skewness.data.frame)
-exportMethods(skewness.default)
-exportMethods(skewness.matrix)
-exportMethods(summary.mic)
-exportMethods(summary.mo)
-exportMethods(summary.rsi)
-importFrom(cleaner,freq)
-importFrom(cleaner,freq.default)
-importFrom(cleaner,percentage)
-importFrom(cleaner,top_freq)
-importFrom(crayon,bgGreen)
-importFrom(crayon,bgRed)
-importFrom(crayon,bgYellow)
-importFrom(crayon,black)
-importFrom(crayon,blue)
-importFrom(crayon,bold)
-importFrom(crayon,green)
-importFrom(crayon,italic)
-importFrom(crayon,magenta)
-importFrom(crayon,make_style)
-importFrom(crayon,red)
-importFrom(crayon,silver)
-importFrom(crayon,strip_style)
-importFrom(crayon,underline)
-importFrom(crayon,white)
-importFrom(crayon,yellow)
-importFrom(data.table,as.data.table)
-importFrom(data.table,data.table)
-importFrom(data.table,setkey)
-importFrom(dplyr,"%>%")
-importFrom(dplyr,all_vars)
-importFrom(dplyr,any_vars)
-importFrom(dplyr,arrange)
-importFrom(dplyr,arrange_at)
-importFrom(dplyr,between)
-importFrom(dplyr,bind_rows)
-importFrom(dplyr,case_when)
-importFrom(dplyr,desc)
-importFrom(dplyr,distinct)
-importFrom(dplyr,everything)
-importFrom(dplyr,filter)
-importFrom(dplyr,filter_all)
-importFrom(dplyr,filter_at)
-importFrom(dplyr,funs)
-importFrom(dplyr,group_by)
-importFrom(dplyr,group_by_at)
-importFrom(dplyr,group_vars)
-importFrom(dplyr,if_else)
-importFrom(dplyr,lag)
-importFrom(dplyr,left_join)
-importFrom(dplyr,mutate)
-importFrom(dplyr,mutate_all)
-importFrom(dplyr,mutate_at)
-importFrom(dplyr,n)
-importFrom(dplyr,n_distinct)
-importFrom(dplyr,n_groups)
-importFrom(dplyr,progress_estimated)
-importFrom(dplyr,pull)
-importFrom(dplyr,rename)
-importFrom(dplyr,row_number)
-importFrom(dplyr,select)
-importFrom(dplyr,select_if)
-importFrom(dplyr,slice)
-importFrom(dplyr,summarise)
-importFrom(dplyr,summarise_if)
-importFrom(dplyr,tibble)
-importFrom(dplyr,transmute)
-importFrom(dplyr,ungroup)
-importFrom(dplyr,vars)
-importFrom(graphics,arrows)
-importFrom(graphics,axis)
-importFrom(graphics,barplot)
-importFrom(graphics,par)
-importFrom(graphics,plot)
-importFrom(graphics,points)
-importFrom(graphics,text)
-importFrom(knitr,kable)
-importFrom(microbenchmark,microbenchmark)
-importFrom(pillar,pillar_shaft)
-importFrom(pillar,type_sum)
-importFrom(rlang,as_label)
-importFrom(rlang,enquos)
-importFrom(stats,complete.cases)
-importFrom(stats,glm)
-importFrom(stats,lm)
-importFrom(stats,pchisq)
-importFrom(stats,predict)
-importFrom(tidyr,pivot_longer)
-importFrom(tidyr,pivot_wider)
-importFrom(utils,adist)
-importFrom(utils,browseURL)
-importFrom(utils,menu)
-importFrom(utils,read.csv)
-importFrom(utils,write.csv)

NEWS.md

@@ -1,827 +0,0 @@
-# AMR 0.9.0
-
-### Breaking
-* Adopted Adeolu *et al.* (2016), [PMID 27620848](https://www.ncbi.nlm.nih.gov/pubmed/27620848) for the `microorganisms` data set, which means that the new order Enterobacterales now consists of a part of the existing family Enterobacteriaceae, but that this family has been split into other families as well (like *Morganellaceae* and *Yersiniaceae*). Although published in 2016, this information is not yet in the Catalogue of Life version of 2019. All MDRO determinations with `mdro()` will now use the Enterobacterales order for all guidelines before 2016 that were dependent on the Enterobacteriaceae family.
-  * If you were dependent on the old Enterobacteriaceae family e.g. by using in your code:
-    ```r
-    if (mo_family(somebugs) == "Enterobacteriaceae") ...
-    ```
-    then please adjust this to:
-    ```r
-    if (mo_order(somebugs) == "Enterobacterales") ...
-    ```
-
-### New
-* Functions `susceptibility()` and `resistance()` as aliases of `proportion_SI()` and `proportion_R()`, respectively. These functions were added to make it more clear that "I" should be considered susceptible and not resistant.
-  ```r
-  library(dplyr)
-  example_isolates %>%
-    group_by(bug = mo_name(mo)) %>% 
-    summarise(amoxicillin = resistance(AMX),
-              amox_clav   = resistance(AMC)) %>%
-    filter(!is.na(amoxicillin) | !is.na(amox_clav))
-  ```
-* Support for a new MDRO guideline: Magiorakos AP, Srinivasan A *et al.* "Multidrug-resistant, extensively drug-resistant and pandrug-resistant bacteria: an international expert proposal for interim standard definitions for acquired resistance." Clinical Microbiology and Infection (2012).
-  * This is now the new default guideline for the `mdro()` function
-  * The new Verbose mode (`mdro(...., verbose = TRUE)`) returns an informative data set where the reason for MDRO determination is given for every isolate, and an list of the resistant antimicrobial agents
-* Data set `antivirals`, containing all entries from the ATC J05 group with their DDDs for oral and parenteral treatment
-
-### Changes
-* Improvements to algorithm in `as.mo()`:
-  * Now allows "ou" where "au" should have been used and vice versa
-  * More intelligent way of coping with some consonants like "l" and "r"
-  * Added a score (a certainty percentage) to `mo_uncertainties()`, that is calculated using the [Levenshtein distance](https://en.wikipedia.org/wiki/Levenshtein_distance):
-    ```r
-    as.mo(c("Stafylococcus aureus",
-            "staphylokok aureuz"))
-    #> Warning: 
-    #> Results of two values were guessed with uncertainty. Use mo_uncertainties() to review them.
-    #> Class 'mo'
-    #> [1] B_STPHY_AURS B_STPHY_AURS
-    
-    mo_uncertainties()
-    #> "Stafylococcus aureus" -> Staphylococcus aureus (B_STPHY_AURS, score: 95.2%)
-    #> "staphylokok aureuz"   -> Staphylococcus aureus (B_STPHY_AURS, score: 85.7%)
-    ```
-* Removed previously deprecated function `as.atc()` - this function was replaced by `ab_atc()`
-* Renamed all `portion_*` functions to `proportion_*`. All `portion_*` functions are still available as deprecated functions, and will return a warning when used.
-* When running `as.rsi()` over a data set, it will now print the guideline that will be used if it is not specified by the user
-* Improvements for `eucast_rules()`:
-  * Fix where *Stenotrophomonas maltophilia* would always become ceftazidime R (following EUCAST v3.1)
-  * Fix where *Leuconostoc* and *Pediococcus* would not always become glycopeptides R
-  * non-EUCAST rules in `eucast_rules()` are now applied first and not as last anymore. This is to improve the dependency on certain antibiotics for the official EUCAST rules. Please see `?eucast_rules`.
-* Fix for interpreting MIC values with `as.rsi()` where the input is `NA`
-* Added "imi" and "imp" as allowed abbreviation for Imipenem (IPM)
-* Fix for automatically determining columns with antibiotic results in `mdro()` and `eucast_rules()`
-* Added ATC codes for ceftaroline, ceftobiprole and faropenem and fixed two typos in the `antibiotics` data set
-* More robust way of determining valid MIC values
-* Small changed to the `example_isolates` data set to better reflect reality
-* Added more microorganisms codes from laboratory systems (esp. species of *Pseudescherichia* and *Rodentibacter*)
-* Added Gram-stain to `mo_info()`
-
-### Other
-* Rewrote the complete documentation to markdown format, to be able to use the very latest version of the great [Roxygen2](https://roxygen2.r-lib.org/index.html), released in November 2019. This tremously improved the documentation quality, since the rewrite forced us to go over all texts again and make changes where needed.
-* Change dependency on `clean` to `cleaner`, as this package was renamed accordingly upon CRAN request
-* Added Dr. Sofia Ny as contributor
-
-# AMR 0.8.0
-
-### Breaking
-* Determination of first isolates now **excludes** all 'unknown' microorganisms at default, i.e. microbial code `"UNKNOWN"`. They can be included with the new parameter `include_unknown`:
-  ```r
-  first_isolate(..., include_unknown = TRUE)
-  ```
-  For WHONET users, this means that all records/isolates with organism code `"con"` (*contamination*) will be excluded at default, since `as.mo("con") = "UNKNOWN"`. The function always shows a note with the number of 'unknown' microorganisms that were included or excluded.
-* For code consistency, classes `ab` and `mo` will now be preserved in any subsetting or assignment. For the sake of data integrity, this means that invalid assignments will now result in `NA`:
-  ```r
-  # how it works in base R:
-  x <- factor("A")
-  x[1] <- "B"
-  #> Warning message:
-  #> invalid factor level, NA generated
-  
-  # how it now works similarly for classes 'mo' and 'ab':
-  x <- as.mo("E. coli")
-  x[1] <- "testvalue"
-  #> Warning message:
-  #> invalid microorganism code, NA generated
-  ```
-  This is important, because a value like `"testvalue"` could never be understood by e.g. `mo_name()`, although the class would suggest a valid microbial code.
-* Function `freq()` has moved to a new package, [`clean`](https://github.com/msberends/clean) ([CRAN link](https://cran.r-project.org/package=clean)), since creating frequency tables actually does not fit the scope of this package. The `freq()` function still works, since it is re-exported from the `clean` package (which will be installed automatically upon updating this `AMR` package).
-* Renamed data set `septic_patients` to `example_isolates`
-
-### New
-* Function `bug_drug_combinations()` to quickly get a `data.frame` with the results of all bug-drug combinations in a data set. The column containing microorganism codes is guessed automatically and its input is transformed with `mo_shortname()` at default:
-  ```r
-  x <- bug_drug_combinations(example_isolates)
-  #> NOTE: Using column `mo` as input for `col_mo`.
-  x[1:4, ]
-  #>             mo  ab S I R total
-  #> 1 A. baumannii AMC 0 0 3     3
-  #> 2 A. baumannii AMK 0 0 0     0
-  #> 3 A. baumannii AMP 0 0 3     3
-  #> 4 A. baumannii AMX 0 0 3     3
-  #> NOTE: Use 'format()' on this result to get a publicable/printable format.
-
-  # change the transformation with the FUN argument to anything you like:
-  x <- bug_drug_combinations(example_isolates, FUN = mo_gramstain)
-  #> NOTE: Using column `mo` as input for `col_mo`.
-  x[1:4, ]
-  #>              mo  ab   S  I   R total
-  #> 1 Gram-negative AMC 469 89 174   732
-  #> 2 Gram-negative AMK 251  0   2   253
-  #> 3 Gram-negative AMP 227  0 405   632
-  #> 4 Gram-negative AMX 227  0 405   632
-  #> NOTE: Use 'format()' on this result to get a publicable/printable format.
-  ```
-  You can format this to a printable format, ready for reporting or exporting to e.g. Excel with the base R `format()` function:
-  ```r
-  format(x, combine_IR = FALSE)
-  ```
-* Additional way to calculate co-resistance, i.e. when using multiple antimicrobials as input for `portion_*` functions or `count_*` functions. This can be used to determine the empiric susceptibility of a combination therapy. A new parameter `only_all_tested` (**which defaults to `FALSE`**) replaces the old `also_single_tested` and can be used to select one of the two methods to count isolates and calculate portions. The difference can be seen in this example table (which is also on the `portion` and `count` help pages), where the %SI is being determined:
-
-  ```r
-  # --------------------------------------------------------------------
-  #                     only_all_tested = FALSE  only_all_tested = TRUE
-  #                     -----------------------  -----------------------
-  #  Drug A    Drug B   include as  include as   include as  include as
-  #                     numerator   denominator  numerator   denominator
-  # --------  --------  ----------  -----------  ----------  -----------
-  #  S or I    S or I       X            X            X            X
-  #    R       S or I       X            X            X            X
-  #   <NA>     S or I       X            X            -            -
-  #  S or I      R          X            X            X            X
-  #    R         R          -            X            -            X
-  #   <NA>       R          -            -            -            -
-  #  S or I     <NA>        X            X            -            -
-  #    R        <NA>        -            -            -            -
-  #   <NA>      <NA>        -            -            -            -
-  # --------------------------------------------------------------------
-  ```
-  
-  Since this is a major change, usage of the old `also_single_tested` will throw an informative error that it has been replaced by `only_all_tested`.
-* `tibble` printing support for classes `rsi`, `mic`, `disk`, `ab` `mo`. When using `tibble`s containing antimicrobial columns, values `S` will print in green, values `I` will print in yellow and values `R` will print in red. Microbial IDs (class `mo`) will emphasise on the genus and species, not on the kingdom.
-  ```r
-  # (run this on your own console, as this page does not support colour printing)
-  library(dplyr)
-  example_isolates %>%
-    select(mo:AMC) %>% 
-    as_tibble()
-  ```
-
-### Changed
-* Many algorithm improvements for `as.mo()` (of which some led to additions to the `microorganisms` data set). Many thanks to all contributors that helped improving the algorithms.
-  * Self-learning algorithm - the function now gains experience from previously determined microorganism IDs and learns from it (yielding 80-95% speed improvement for any guess after the first try)
-  * Big improvement for misspelled input
-  * These new trivial names known to the field are now understood: meningococcus, gonococcus, pneumococcus
-  * Updated to the latest taxonomic data (updated to August 2019, from the International Journal of Systematic and Evolutionary Microbiology
-  * Added support for Viridans Group Streptococci (VGS) and Milleri Group Streptococci (MGS)
-  * Added support for *Blastocystis*
-  * Added support for 5,000 new fungi
-  * Added support for unknown yeasts and fungi
-  * Changed most microorganism IDs to improve readability. For example, the old code `B_ENTRC_FAE` could have been both *E. faecalis* and *E. faecium*. Its new code is `B_ENTRC_FCLS` and *E. faecium* has become `B_ENTRC_FACM`. Also, the Latin character æ (ae) is now preserved at the start of each genus and species abbreviation. For example, the old code for *Aerococcus urinae* was `B_ARCCC_NAE`. This is now `B_AERCC_URIN`.
-    **IMPORTANT:** Old microorganism IDs are still supported, but support will be dropped in a future version. Use `as.mo()` on your old codes to transform them to the new format. Using functions from the `mo_*` family (like `mo_name()` and `mo_gramstain()`) on old codes, will throw a warning.
-* More intelligent guessing for `as.ab()`, including bidirectional language support
-* Added support for the German national guideline (3MRGN/4MRGN) in the `mdro()` function, to determine multi-drug resistant organisms
-* Function `eucast_rules()`:
-  * Fixed a bug for *Yersinia pseudotuberculosis*
-  * Added more informative errors and warnings
-  * Printed info now distinguishes between added and changes values
-  * Using Verbose mode (i.e. `eucast_rules(..., verbose = TRUE)`) returns more informative and readable output
-  * Using factors as input now adds missing factors levels when the function changes antibiotic results
-* Improved the internal auto-guessing function for determining antimicrobials in your data set (`AMR:::get_column_abx()`)
-* Removed class `atc` - using `as.atc()` is now deprecated in favour of `ab_atc()` and this will return a character, not the `atc` class anymore
-* Removed deprecated functions `abname()`, `ab_official()`, `atc_name()`, `atc_official()`, `atc_property()`, `atc_tradenames()`, `atc_trivial_nl()`
-* Fix and speed improvement for `mo_shortname()`
-* Fix for using `mo_*` functions where the coercion uncertainties and failures would not be available through `mo_uncertainties()` and `mo_failures()` anymore
-* Deprecated the `country` parameter of `mdro()` in favour of the already existing `guideline` parameter to support multiple guidelines within one country
-* The `name` of `RIF` is now Rifampicin instead of Rifampin
-* The `antibiotics` data set is now sorted by name and all cephalosporins now have their generation between brackets
-* Speed improvement for `guess_ab_col()` which is now 30 times faster for antibiotic abbreviations
-* Improved `filter_ab_class()` to be more reliable and to support 5th generation cephalosporins
-* Function `availability()` now uses `portion_R()` instead of `portion_IR()`, to comply with EUCAST insights
-* Functions `age()` and `age_groups()` now have a `na.rm` parameter to remove empty values
-* Renamed function `p.symbol()` to `p_symbol()` (the former is now deprecated and will be removed in a future version)
-* Using negative values for `x` in `age_groups()` will now introduce `NA`s and not return an error anymore
-* Fix for determining the system's language
-* Fix for `key_antibiotics()` on foreign systems
-* Added 80 new LIS codes for microorganisms
-* Relabeled the factor levels of `mdr_tb()`
-* Added more MIC factor levels (`as.mic()`)
-
-#### Other
-* Added Prof. Dr. Casper Albers as doctoral advisor and added Dr. Judith Fonville, Eric Hazenberg, Dr. Bart Meijer, Dr. Dennis Souverein and Annick Lenglet as contributors
-* Cleaned the coding style of every single syntax line in this package with the help of the `lintr` package
-
-# AMR 0.7.1
-
-#### New
-* Function `rsi_df()` to transform a `data.frame` to a data set containing only the microbial interpretation (S, I, R), the antibiotic, the percentage of S/I/R and the number of available isolates. This is a convenient combination of the existing functions `count_df()` and `portion_df()` to immediately show resistance percentages and number of available isolates:
-  ```r
-  septic_patients %>%
-    select(AMX, CIP) %>%
-    rsi_df()
-  #      antibiotic  interpretation      value  isolates
-  # 1   Amoxicillin              SI  0.4442636       546
-  # 2   Amoxicillin               R  0.5557364       683
-  # 3 Ciprofloxacin              SI  0.8381831      1181
-  # 4 Ciprofloxacin               R  0.1618169       228
-  ```
-* Support for all scientifically published pathotypes of *E. coli* to date (that we could find). Supported are: 
-
-  * AIEC (Adherent-Invasive *E. coli*) 
-  * ATEC (Atypical Entero-pathogenic *E. coli*) 
-  * DAEC (Diffusely Adhering *E. coli*) 
-  * EAEC (Entero-Aggresive *E. coli*) 
-  * EHEC (Entero-Haemorrhagic *E. coli*) 
-  * EIEC (Entero-Invasive *E. coli*) 
-  * EPEC (Entero-Pathogenic *E. coli*) 
-  * ETEC (Entero-Toxigenic *E. coli*) 
-  * NMEC (Neonatal Meningitis‐causing *E. coli*) 
-  * STEC (Shiga-toxin producing *E. coli*) 
-  * UPEC (Uropathogenic *E. coli*)
-  
-  All these lead to the microbial ID of *E. coli*:
-  ```r
-  as.mo("UPEC")
-  # B_ESCHR_COL
-  mo_name("UPEC")
-  # "Escherichia coli"
-  mo_gramstain("EHEC")
-  # "Gram-negative"
-  ```
-* Function `mo_info()` as an analogy to `ab_info()`. The `mo_info()` prints a list with the full taxonomy, authors, and the URL to the online database of a microorganism
-* Function `mo_synonyms()` to get all previously accepted taxonomic names of a microorganism
-
-#### Changed
-* Column names of output `count_df()` and `portion_df()` are now lowercase
-* Fixed bug in translation of microorganism names
-* Fixed bug in determining taxonomic kingdoms
-* Algorithm improvements for `as.ab()` and `as.mo()` to understand even more severely misspelled input
-* Function `as.ab()` now allows spaces for coercing antibiotics names
-* Added `ggplot2` methods for automatically determining the scale type of classes `mo` and `ab`
-* Added names of object in the header in frequency tables, even when using pipes
-* Prevented `"bacteria"` from getting coerced by `as.ab()` because Bacterial is a brand name of trimethoprim (TMP)
-* Fixed a bug where setting an antibiotic would not work for `eucast_rules()` and `mdro()`
-* Fixed a EUCAST rule for Staphylococci, where amikacin resistance would not be inferred from tobramycin
-* Removed `latest_annual_release` from the `catalogue_of_life_version()` function
-* Removed antibiotic code `PVM1` from the `antibiotics` data set as this was a duplicate of `PME`
-* Fixed bug where not all old taxonomic names would be printed, when using a vector as input for `as.mo()`
-* Manually added *Trichomonas vaginalis* from the kingdom of Protozoa, which is missing from the Catalogue of Life
-* Small improvements to `plot()` and `barplot()` for MIC and RSI classes
-* Allow Catalogue of Life IDs to be coerced by `as.mo()`
-
-#### Other
-* Fixed a note thrown by CRAN tests
-
-# AMR 0.7.0
-
-#### New
-* Support for translation of disk diffusion and MIC values to RSI values (i.e. antimicrobial interpretations). Supported guidelines are EUCAST (2011 to 2019) and CLSI (2011 to 2019). Use `as.rsi()` on an MIC value (created with `as.mic()`), a disk diffusion value (created with the new `as.disk()`) or on a complete date set containing columns with MIC or disk diffusion values.
-* Function `mo_name()` as alias of `mo_fullname()`
-* Added guidelines of the WHO to determine multi-drug resistance (MDR) for TB (`mdr_tb()`) and added a new vignette about MDR. Read this tutorial [here on our website](https://msberends.gitlab.io/AMR/articles/MDR.html).
-
-#### Changed
-* Fixed a critical bug in `first_isolate()` where missing species would lead to incorrect FALSEs. This bug was not present in AMR v0.5.0, but was in v0.6.0 and v0.6.1.
-* Fixed a bug in `eucast_rules()` where antibiotics from WHONET software would not be recognised
-* Completely reworked the `antibiotics` data set:
-  * All entries now have 3 different identifiers:
-    * Column `ab` contains a human readable EARS-Net code, used by ECDC and WHO/WHONET - this is the primary identifier used in this package
-    * Column `atc` contains the ATC code, used by WHO/WHOCC
-    * Column `cid` contains the CID code (Compound ID), used by PubChem
-  * Based on the Compound ID, almost 5,000 official brand names have been added from many different countries
-  * All references to antibiotics in our package now use EARS-Net codes, like `AMX` for amoxicillin
-  * Functions `atc_certe`, `ab_umcg` and `atc_trivial_nl` have been removed
-  * All `atc_*` functions are superceded by `ab_*` functions
-  * All output will be translated by using an included translation file which [can be viewed here](https://gitlab.com/msberends/AMR/blob/master/data-raw/translations.tsv).
-    
-    Please [create an issue in one of our repositories](https://gitlab.com/msberends/AMR/issues/new?issue[title]=Translation%20suggestion) if you want additions in this file.
-* Improvements to plotting AMR results with `ggplot_rsi()`:
-  * New parameter `colours` to set the bar colours
-  * New parameters `title`, `subtitle`, `caption`, `x.title` and `y.title` to set titles and axis descriptions
-* Improved intelligence of looking up antibiotic columns in a data set using `guess_ab_col()`
-* Added ~5,000 more old taxonomic names to the `microorganisms.old` data set, which leads to better results finding when using the `as.mo()` function
-* This package now honours the new EUCAST insight (2019) that S and I are but classified as susceptible, where I is defined as 'increased exposure' and not 'intermediate' anymore. For functions like `portion_df()` and `count_df()` this means that their new parameter `combine_SI` is TRUE at default. Our plotting function `ggplot_rsi()` also reflects this change since it uses `count_df()` internally.
-* The `age()` function gained a new parameter `exact` to determine ages with decimals
-* Removed deprecated functions `guess_mo()`, `guess_atc()`, `EUCAST_rules()`, `interpretive_reading()`, `rsi()`
-* Frequency tables (`freq()`):
-  * speed improvement for microbial IDs
-  * fixed factor level names for R Markdown
-  * when all values are unique it now shows a message instead of a warning
-  * support for boxplots:
-    ```r
-    septic_patients %>% 
-      freq(age) %>% 
-      boxplot()
-    # grouped boxplots:
-    septic_patients %>% 
-      group_by(hospital_id) %>% 
-      freq(age) %>%
-      boxplot()
-    ```
-* Removed all hardcoded EUCAST rules and replaced them with a new reference file which [can be viewed here](https://gitlab.com/msberends/AMR/blob/master/data-raw/eucast_rules.tsv).
-  
-  Please [create an issue in one of our repositories](https://gitlab.com/msberends/AMR/issues/new?issue[title]=EUCAST%20edit) if you want changes in this file.
-* Added ceftazidim intrinsic resistance to *Streptococci*
-* Changed default settings for `age_groups()`, to let groups of fives and tens end with 100+ instead of 120+
-* Fix for `freq()` for when all values are `NA`
-* Fix for `first_isolate()` for when dates are missing
-* Improved speed of `guess_ab_col()`
-* Function `as.mo()` now gently interprets any number of whitespace characters (like tabs) as one space
-* Function `as.mo()` now returns `UNKNOWN` for `"con"` (WHONET ID of 'contamination') and returns `NA` for `"xxx"`(WHONET ID of 'no growth')
-* Small algorithm fix for `as.mo()`
-* Removed viruses from data set `microorganisms.codes` and cleaned it up
-* Fix for `mo_shortname()` where species would not be determined correctly
-
-#### Other
-* Support for R 3.6.0 and later by providing support for [staged install](https://developer.r-project.org/Blog/public/2019/02/14/staged-install/index.html)
-
-# AMR 0.6.1
-
-#### Changed
-* Fixed a critical bug when using `eucast_rules()` with `verbose = TRUE`
-* Coercion of microbial IDs are now written to the package namespace instead of the user's home folder, to comply with the CRAN policy
-
-# AMR 0.6.0
-
-**New website!**
-
-We've got a new website: [https://msberends.gitlab.io/AMR](https://msberends.gitlab.io/AMR/) (built with the great [`pkgdown`](https://pkgdown.r-lib.org/))
-
-* Contains the complete manual of this package and all of its functions with an explanation of their parameters
-* Contains a comprehensive tutorial about how to conduct antimicrobial resistance analysis, import data from WHONET or SPSS and many more.
-
-#### New
-* **BREAKING**: removed deprecated functions, parameters and references to 'bactid'. Use `as.mo()` to identify an MO code.
-* Catalogue of Life as a new taxonomic source for data about microorganisms, which also contains all ITIS data we used previously. The `microorganisms` data set now contains:
-  * All ~55,000 (sub)species from the kingdoms of Archaea, Bacteria and Protozoa
-  * All ~3,000 (sub)species from these orders of the kingdom of Fungi: Eurotiales, Onygenales, Pneumocystales, Saccharomycetales and Schizosaccharomycetales (covering at least like all species of *Aspergillus*, *Candida*, *Pneumocystis*, *Saccharomyces* and *Trichophyton*)
-  * All ~2,000 (sub)species from ~100 other relevant genera, from the kingdoms of Animalia and Plantae (like *Strongyloides* and *Taenia*)
-  * All ~15,000 previously accepted names of included (sub)species that have been taxonomically renamed
-  * The responsible author(s) and year of scientific publication
-  
-    This data is updated annually - check the included version with the new function `catalogue_of_life_version()`.
-  * Due to this change, some `mo` codes changed (e.g. *Streptococcus* changed from `B_STRPTC` to `B_STRPT`). A translation table is  used internally to support older microorganism IDs, so users will not notice this difference.
-  * New function `mo_rank()` for the taxonomic rank (genus, species, infraspecies, etc.)
-  * New function `mo_url()` to get the direct URL of a species from the Catalogue of Life
-* Support for data from [WHONET](https://whonet.org/) and [EARS-Net](https://ecdc.europa.eu/en/about-us/partnerships-and-networks/disease-and-laboratory-networks/ears-net) (European Antimicrobial Resistance Surveillance Network):
-  * Exported files from WHONET can be read and used in this package. For functions like `first_isolate()` and `eucast_rules()`, all parameters will be filled in automatically.
-  * This package now knows all antibiotic abbrevations by EARS-Net (which are also being used by WHONET) - the `antibiotics` data set now contains a column `ears_net`.
-  * The function `as.mo()` now knows all WHONET species abbreviations too, because almost 2,000 microbial abbreviations were added to the `microorganisms.codes` data set.
-* New filters for antimicrobial classes. Use these functions to filter isolates on results in one of more antibiotics from a specific class:
-  ```r
-  filter_aminoglycosides()
-  filter_carbapenems()
-  filter_cephalosporins()
-  filter_1st_cephalosporins()
-  filter_2nd_cephalosporins()
-  filter_3rd_cephalosporins()
-  filter_4th_cephalosporins()
-  filter_fluoroquinolones()
-  filter_glycopeptides()
-  filter_macrolides()
-  filter_tetracyclines()
-  ```
-  The `antibiotics` data set will be searched, after which the input data will be checked for column names with a value in any abbreviations, codes or official names found in the `antibiotics` data set.
-  For example:
-  ```r
-  septic_patients %>% filter_glycopeptides(result = "R")
-  # Filtering on glycopeptide antibacterials: any of `vanc` or `teic` is R
-  septic_patients %>% filter_glycopeptides(result = "R", scope = "all")
-  # Filtering on glycopeptide antibacterials: all of `vanc` and `teic` is R
-  ```
-* All `ab_*` functions are deprecated and replaced by `atc_*` functions:
-  ```r
-  ab_property -> atc_property()
-  ab_name -> atc_name()
-  ab_official -> atc_official()
-  ab_trivial_nl -> atc_trivial_nl()
-  ab_certe -> atc_certe()
-  ab_umcg -> atc_umcg()
-  ab_tradenames -> atc_tradenames()
-  ```
-  These functions use `as.atc()` internally. The old `atc_property` has been renamed `atc_online_property()`. This is done for two reasons: firstly, not all ATC codes are of antibiotics (ab) but can also be of antivirals or antifungals. Secondly, the input must have class `atc` or must be coerable to this class. Properties of these classes should start with the same class name, analogous to `as.mo()` and e.g. `mo_genus`.
-* New functions `set_mo_source()` and `get_mo_source()` to use your own predefined MO codes as input for `as.mo()` and consequently all `mo_*` functions
-* Support for the upcoming [`dplyr`](https://dplyr.tidyverse.org) version 0.8.0
-* New function `guess_ab_col()` to find an antibiotic column in a table
-* New function `mo_failures()` to review values that could not be coerced to a valid MO code, using `as.mo()`. This latter function will now only show a maximum of 10 uncoerced values and will refer to `mo_failures()`.
-* New function `mo_uncertainties()` to review values that could be coerced to a valid MO code using `as.mo()`, but with uncertainty.
-* New function `mo_renamed()` to get a list of all returned values from `as.mo()` that have had taxonomic renaming
-* New function `age()` to calculate the (patients) age in years
-* New function `age_groups()` to split ages into custom or predefined groups (like children or elderly). This allows for easier demographic antimicrobial resistance analysis per age group.
-* New function `ggplot_rsi_predict()` as well as the base R `plot()` function can now be used for resistance prediction calculated with `resistance_predict()`:
-  ```r
-  x <- resistance_predict(septic_patients, col_ab = "amox")
-  plot(x)
-  ggplot_rsi_predict(x)
-  ```
-* Functions `filter_first_isolate()` and `filter_first_weighted_isolate()` to shorten and fasten filtering on data sets with antimicrobial results, e.g.:
-  ```r
-  septic_patients %>% filter_first_isolate(...)
-  # or
-  filter_first_isolate(septic_patients, ...)
-  ```
-  is equal to:
-  ```r
-  septic_patients %>%
-    mutate(only_firsts = first_isolate(septic_patients, ...)) %>%
-    filter(only_firsts == TRUE) %>%
-    select(-only_firsts)
-  ```
-* New function `availability()` to check the number of available (non-empty) results in a `data.frame`
-* New vignettes about how to conduct AMR analysis, predict antimicrobial resistance, use the *G*-test and more. These are also available (and even easier readable) on our website: https://msberends.gitlab.io/AMR.
-
-#### Changed
-* Function `eucast_rules()`:
-  * Updated EUCAST Clinical breakpoints to [version 9.0 of 1 January 2019](http://www.eucast.org/clinical_breakpoints/), the data set `septic_patients` now reflects these changes
-  * Fixed a critical bug where some rules that depend on previous applied rules would not be applied adequately
-  * Emphasised in manual that penicillin is meant as benzylpenicillin (ATC [J01CE01](https://www.whocc.no/atc_ddd_index/?code=J01CE01))
-  * New info is returned when running this function, stating exactly what has been changed or added. Use `eucast_rules(..., verbose = TRUE)` to get a data set with all changed per bug and drug combination.
-* Removed data sets `microorganisms.oldDT`, `microorganisms.prevDT`, `microorganisms.unprevDT` and `microorganismsDT` since they were no longer needed and only contained info already available in the `microorganisms` data set
-* Added 65 antibiotics to the `antibiotics` data set, from the [Pharmaceuticals Community Register](http://ec.europa.eu/health/documents/community-register/html/atc.htm) of the European Commission
-* Removed columns `atc_group1_nl` and `atc_group2_nl` from the `antibiotics` data set
-* Functions `atc_ddd()` and `atc_groups()` have been renamed `atc_online_ddd()` and `atc_online_groups()`. The old functions are deprecated and will be removed in a future version.
-* Function `guess_mo()` is now deprecated in favour of `as.mo()` and will be removed in future versions
-* Function `guess_atc()` is now deprecated in favour of `as.atc()` and will be removed in future versions
-* Improvements for `as.mo()`:
-  * Now handles incorrect spelling, like `i` instead of `y` and `f` instead of `ph`:
-    ```r
-    # mo_fullname() uses as.mo() internally
-    
-    mo_fullname("Sthafilokockus aaureuz")
-    #> [1] "Staphylococcus aureus"
-    
-    mo_fullname("S. klossi")
-    #> [1] "Staphylococcus kloosii"
-    ```
-  * Uncertainty of the algorithm is now divided into four levels, 0 to 3, where the default `allow_uncertain = TRUE` is equal to uncertainty level 2. Run `?as.mo` for more info about these levels.
-    ```r
-    # equal:
-    as.mo(..., allow_uncertain = TRUE)
-    as.mo(..., allow_uncertain = 2)
-    
-    # also equal:
-    as.mo(..., allow_uncertain = FALSE)
-    as.mo(..., allow_uncertain = 0)
-    ```
-    Using `as.mo(..., allow_uncertain = 3)` could lead to very unreliable results.
-  * Implemented the latest publication of Becker *et al.* (2019), for categorising coagulase-negative *Staphylococci*
-  * All microbial IDs that found are now saved to a local file `~/.Rhistory_mo`. Use the new function `clean_mo_history()` to delete this file, which resets the algorithms.
-  * Incoercible results will now be considered 'unknown', MO code `UNKNOWN`. On foreign systems, properties of these will be translated to all languages already previously supported: German, Dutch, French, Italian, Spanish and Portuguese:
-    ```r
-    mo_genus("qwerty", language = "es")
-    # Warning: 
-    # one unique value (^= 100.0%) could not be coerced and is considered 'unknown': "qwerty". Use mo_failures() to review it.
-    #> [1] "(género desconocido)"
-    ```
-  * Fix for vector containing only empty values
-  * Finds better results when input is in other languages
-  * Better handling for subspecies
-  * Better handling for *Salmonellae*, especially the 'city like' serovars like *Salmonella London*
-  * Understanding of highly virulent *E. coli* strains like EIEC, EPEC and STEC
-  * There will be looked for uncertain results at default - these results will be returned with an informative warning
-  * Manual (help page) now contains more info about the algorithms
-  * Progress bar will be shown when it takes more than 3 seconds to get results
-  * Support for formatted console text
-  * Console will return the percentage of uncoercable input
-* Function `first_isolate()`:
-  * Fixed a bug where distances between dates would not be calculated right - in the `septic_patients` data set this yielded a difference of 0.15% more isolates
-  * Will now use a column named like "patid" for the patient ID (parameter `col_patientid`), when this parameter was left blank
-  * Will now use a column named like "key(...)ab" or "key(...)antibiotics" for the key antibiotics (parameter `col_keyantibiotics()`), when this parameter was left blank
-  * Removed parameter `output_logical`, the function will now always return a logical value
-  * Renamed parameter `filter_specimen` to `specimen_group`, although using `filter_specimen` will still work
-* A note to the manual pages of the `portion` functions, that low counts can influence the outcome and that the `portion` functions may camouflage this, since they only return the portion (albeit being dependent on the `minimum` parameter)
-* Merged data sets `microorganisms.certe` and `microorganisms.umcg` into `microorganisms.codes`
-* Function `mo_taxonomy()` now contains the kingdom too
-* Reduce false positives for `is.rsi.eligible()` using the new `threshold` parameter
-* New colours for `scale_rsi_colours()`
-* Summaries of class `mo` will now return the top 3 and the unique count, e.g. using `summary(mo)`
-* Small text updates to summaries of class `rsi` and `mic`
-* Function `as.rsi()`:
-  * Now gives a warning when inputting MIC values
-  * Now accepts high and low resistance: `"HIGH S"` will return `S`
-* Frequency tables (`freq()` function):
-  * Support for tidyverse quasiquotation! Now you can create frequency tables of function outcomes:
-    ```r
-    # Determine genus of microorganisms (mo) in `septic_patients` data set:
-    # OLD WAY
-    septic_patients %>%
-      mutate(genus = mo_genus(mo)) %>%
-      freq(genus)
-    # NEW WAY
-    septic_patients %>% 
-      freq(mo_genus(mo))
-    
-    # Even supports grouping variables:
-    septic_patients %>%
-      group_by(gender) %>% 
-      freq(mo_genus(mo))
-    ```
-  * Header info is now available as a list, with the `header` function
-  * The parameter `header` is now set to `TRUE` at default, even for markdown
-  * Added header info for class `mo` to show unique count of families, genera and species
-  * Now honours the `decimal.mark` setting, which just like `format` defaults to `getOption("OutDec")`
-  * The new `big.mark` parameter will at default be `","` when `decimal.mark = "."` and `"."` otherwise
-  * Fix for header text where all observations are `NA`
-  * New parameter `droplevels` to exclude empty factor levels when input is a factor
-  * Factor levels will be in header when present in input data (maximum of 5)
-  * Fix for using `select()` on frequency tables
-* Function `scale_y_percent()` now contains the `limits` parameter
-* Automatic parameter filling for `mdro()`, `key_antibiotics()` and `eucast_rules()`
-* Updated examples for resistance prediction (`resistance_predict()` function)
-* Fix for `as.mic()` to support more values ending in (several) zeroes
-* if using different lengths of pattern and x in `%like%`, it will now return the call
-
-#### Other
-* Updated licence text to emphasise GPL 2.0 and that this is an R package.
-
-# AMR 0.5.0
-
-#### New
-* Repository moved to GitLab: https://gitlab.com/msberends/AMR
-* Function `count_all` to get all available isolates (that like all `portion_*` and `count_*` functions also supports `summarise` and `group_by`), the old `n_rsi` is now an alias of `count_all`
-* Function `get_locale` to determine language for language-dependent output for some `mo_*` functions. This is now the default value for their `language` parameter, by which the system language will be used at default.
-* Data sets `microorganismsDT`, `microorganisms.prevDT`, `microorganisms.unprevDT` and `microorganisms.oldDT` to improve the speed of `as.mo`. They are for reference only, since they are primarily for internal use of `as.mo`.
-* Function `read.4D` to read from the 4D database of the MMB department of the UMCG
-* Functions `mo_authors` and `mo_year` to get specific values about the scientific reference of a taxonomic entry
-
-#### Changed
-* Functions `MDRO`, `BRMO`, `MRGN` and `EUCAST_exceptional_phenotypes` were renamed to `mdro`, `brmo`, `mrgn` and `eucast_exceptional_phenotypes`
-* `EUCAST_rules` was renamed to `eucast_rules`, the old function still exists as a deprecated function
-* Big changes to the `eucast_rules` function:
-  * Now also applies rules from the EUCAST 'Breakpoint tables for bacteria', version 8.1, 2018, http://www.eucast.org/clinical_breakpoints/ (see Source of the function)
-  * New parameter `rules` to specify which rules should be applied (expert rules, breakpoints, others or all)
-  * New parameter `verbose` which can be set to `TRUE` to get very specific messages about which columns and rows were affected
-  * Better error handling when rules cannot be applied (i.e. new values could not be inserted)
-  * The number of affected values will now only be measured once per row/column combination
-  * Data set `septic_patients` now reflects these changes
-  * Added parameter `pipe` for piperacillin (J01CA12), also to the `mdro` function
-  * Small fixes to EUCAST clinical breakpoint rules
-* Added column `kingdom` to the microorganisms data set, and function `mo_kingdom` to look up values
-* Tremendous speed improvement for `as.mo` (and subsequently all `mo_*` functions), as empty values wil be ignored *a priori*
-* Fewer than 3 characters as input for `as.mo` will return NA
-* Function `as.mo` (and all `mo_*` wrappers) now supports genus abbreviations with "species" attached
-  ```r
-  as.mo("E. species")        # B_ESCHR
-  mo_fullname("E. spp.")     # "Escherichia species"
-  as.mo("S. spp")            # B_STPHY
-  mo_fullname("S. species")  # "Staphylococcus species"
-  ```
-* Added parameter `combine_IR` (TRUE/FALSE) to functions `portion_df` and `count_df`, to indicate that all values of I and R must be merged into one, so the output only consists of S vs. IR (susceptible vs. non-susceptible)
-* Fix for `portion_*(..., as_percent = TRUE)` when minimal number of isolates would not be met
-* Added parameter `also_single_tested` for `portion_*` and `count_*` functions to also include cases where not all antibiotics were tested but at least one of the tested antibiotics includes the target antimicribial interpretation, see `?portion`
-* Using `portion_*` functions now throws a warning when total available isolate is below parameter `minimum`
-* Functions `as.mo`, `as.rsi`, `as.mic`, `as.atc` and `freq` will not set package name as attribute anymore
-* Frequency tables - `freq()`:
-  * Support for grouping variables, test with:
-    ```r
-    septic_patients %>% 
-      group_by(hospital_id) %>% 
-      freq(gender)
-    ```
-  * Support for (un)selecting columns:
-    ```r
-    septic_patients %>% 
-      freq(hospital_id) %>% 
-      select(-count, -cum_count) # only get item, percent, cum_percent
-    ```
-  * Check for `hms::is.hms`
-  * Now prints in markdown at default in non-interactive sessions
-  * No longer adds the factor level column and sorts factors on count again
-  * Support for class `difftime`
-  * New parameter `na`, to choose which character to print for empty values
-  * New parameter `header` to turn the header info off (default when `markdown = TRUE`)
-  * New parameter `title` to manually setbthe title of the frequency table
-* `first_isolate` now tries to find columns to use as input when parameters are left blank
-* Improvements for MDRO algorithm (function `mdro`)
-* Data set `septic_patients` is now a `data.frame`, not a tibble anymore
-* Removed diacritics from all authors (columns `microorganisms$ref` and `microorganisms.old$ref`) to comply with CRAN policy to only allow ASCII characters
-* Fix for `mo_property` not working properly
-* Fix for `eucast_rules` where some Streptococci would become ceftazidime R in EUCAST rule 4.5
-* Support for named vectors of class `mo`, useful for `top_freq()`
-* `ggplot_rsi` and `scale_y_percent` have `breaks` parameter
-* AI improvements for `as.mo`:
-  * `"CRS"` -> *Stenotrophomonas maltophilia*
-  * `"CRSM"` -> *Stenotrophomonas maltophilia*
-  * `"MSSA"` -> *Staphylococcus aureus*
-  * `"MSSE"` -> *Staphylococcus epidermidis*
-* Fix for `join` functions
-* Speed improvement for `is.rsi.eligible`, now 15-20 times faster
-* In `g.test`, when `sum(x)` is below 1000 or any of the expected values is below 5, Fisher's Exact Test will be suggested
-* `ab_name` will try to fall back on `as.atc` when no results are found
-* Removed the addin to view data sets
-* Percentages will now will rounded more logically (e.g. in `freq` function)
-
-#### Other
-* New dependency on package `crayon`, to support formatted text in the console
-* Dependency `tidyr` is now mandatory (went to `Import` field) since `portion_df` and `count_df` rely on it
-* Updated vignettes to comply with README
-
-
-# AMR 0.4.0
-
-#### New
-* The data set `microorganisms` now contains **all microbial taxonomic data from ITIS** (kingdoms Bacteria, Fungi and Protozoa), the Integrated Taxonomy Information System, available via https://itis.gov. The data set now contains more than 18,000 microorganisms with all known bacteria, fungi and protozoa according ITIS with genus, species, subspecies, family, order, class, phylum and subkingdom. The new data set `microorganisms.old` contains all previously known taxonomic names from those kingdoms.
-* New functions based on the existing function `mo_property`:
-  * Taxonomic names: `mo_phylum`, `mo_class`, `mo_order`, `mo_family`, `mo_genus`, `mo_species`, `mo_subspecies`
-  * Semantic names: `mo_fullname`, `mo_shortname`
-  * Microbial properties: `mo_type`, `mo_gramstain`
-  * Author and year: `mo_ref`
-  
-  They also come with support for German, Dutch, French, Italian, Spanish and Portuguese:
-  ```r
-  mo_gramstain("E. coli")
-  # [1] "Gram negative"
-  mo_gramstain("E. coli", language = "de") # German
-  # [1] "Gramnegativ"
-  mo_gramstain("E. coli", language = "es") # Spanish
-  # [1] "Gram negativo"
-  mo_fullname("S. group A", language = "pt") # Portuguese
-  # [1] "Streptococcus grupo A"
-  ```
-  
-  Furthermore, former taxonomic names will give a note about the current taxonomic name:
-  ```r
-  mo_gramstain("Esc blattae")
-  # Note: 'Escherichia blattae' (Burgess et al., 1973) was renamed 'Shimwellia blattae' (Priest and Barker, 2010)
-  # [1] "Gram negative"
-  ```
-* Functions `count_R`, `count_IR`, `count_I`, `count_SI` and `count_S` to selectively count resistant or susceptible isolates
-  * Extra function `count_df` (which works like `portion_df`) to get all counts of S, I and R of a data set with antibiotic columns, with support for grouped variables
-* Function `is.rsi.eligible` to check for columns that have valid antimicrobial results, but do not have the `rsi` class yet. Transform the columns of your raw data with: `data %>% mutate_if(is.rsi.eligible, as.rsi)`
-* Functions `as.mo` and `is.mo` as replacements for `as.bactid` and `is.bactid` (since the `microoganisms` data set not only contains bacteria). These last two functions are deprecated and will be removed in a future release. The `as.mo` function determines microbial IDs using intelligent rules:
-  ```r
-  as.mo("E. coli")
-  # [1] B_ESCHR_COL
-  as.mo("MRSA")
-  # [1] B_STPHY_AUR
-  as.mo("S group A")
-  # [1] B_STRPTC_GRA
-  ```
-  And with great speed too - on a quite regular Linux server from 2007 it takes us less than 0.02 seconds to transform 25,000 items:
-  ```r
-  thousands_of_E_colis <- rep("E. coli", 25000)
-  microbenchmark::microbenchmark(as.mo(thousands_of_E_colis), unit = "s")
-  # Unit: seconds
-  #         min       median         max  neval
-  #  0.01817717  0.01843957  0.03878077    100
-  ```
-* Added parameter `reference_df` for `as.mo`, so users can supply their own microbial IDs, name or codes as a reference table
-* Renamed all previous references to `bactid` to `mo`, like:
-  * Column names inputs of `EUCAST_rules`, `first_isolate` and `key_antibiotics`
-  * Column names of datasets `microorganisms` and `septic_patients`
-  * All old syntaxes will still work with this version, but will throw warnings
-* Function `labels_rsi_count` to print datalabels on a RSI `ggplot2` model
-* Functions `as.atc` and `is.atc` to transform/look up antibiotic ATC codes as defined by the WHO. The existing function `guess_atc` is now an alias of `as.atc`.
-
-* Function `ab_property` and its aliases: `ab_name`, `ab_tradenames`, `ab_certe`, `ab_umcg` and `ab_trivial_nl`
-* Introduction to AMR as a vignette
-* Removed clipboard functions as it violated the CRAN policy
-* Renamed `septic_patients$sex` to `septic_patients$gender`
-
-#### Changed
-* Added three antimicrobial agents to the `antibiotics` data set: Terbinafine (D01BA02), Rifaximin (A07AA11) and Isoconazole (D01AC05)
-* Added 163 trade names to the `antibiotics` data set, it now contains 298 different trade names in total, e.g.:
-  ```r
-  ab_official("Bactroban")
-  # [1] "Mupirocin"
-  ab_name(c("Bactroban", "Amoxil", "Zithromax", "Floxapen"))
-  # [1] "Mupirocin" "Amoxicillin" "Azithromycin" "Flucloxacillin"
-  ab_atc(c("Bactroban", "Amoxil", "Zithromax", "Floxapen"))
-  # [1] "R01AX06" "J01CA04" "J01FA10" "J01CF05"
-  ```
-* For `first_isolate`, rows will be ignored when there's no species available
-* Function `ratio` is now deprecated and will be removed in a future release, as it is not really the scope of this package
-* Fix for `as.mic` for values ending in zeroes after a real number
-* Small fix where *B. fragilis* would not be found in the `microorganisms.umcg` data set
-* Added `prevalence` column to the `microorganisms` data set
-* Added parameters `minimum` and `as_percent` to `portion_df`
-* Support for quasiquotation in the functions series `count_*` and `portions_*`, and `n_rsi`. This allows to check for more than 2 vectors or columns.
-  ```r
-  septic_patients %>% select(amox, cipr) %>% count_IR()
-  # which is the same as:
-  septic_patients %>% count_IR(amox, cipr)
-  
-  septic_patients %>% portion_S(amcl)
-  septic_patients %>% portion_S(amcl, gent)
-  septic_patients %>% portion_S(amcl, gent, pita)
-  ```
-* Edited `ggplot_rsi` and `geom_rsi` so they can cope with `count_df`. The new `fun` parameter has value `portion_df` at default, but can be set to `count_df`.
-* Fix for `ggplot_rsi` when the `ggplot2` package was not loaded
-* Added datalabels function `labels_rsi_count` to `ggplot_rsi`
-* Added possibility to set any parameter to `geom_rsi` (and `ggplot_rsi`) so you can set your own preferences
-* Fix for joins, where predefined suffices would not be honoured
-* Added parameter `quote` to the `freq` function
-* Added generic function `diff` for frequency tables
-* Added longest en shortest character length in the frequency table (`freq`) header of class `character`
-* Support for types (classes) list and matrix for `freq`
-  ```r
-  my_matrix = with(septic_patients, matrix(c(age, gender), ncol = 2))
-  freq(my_matrix)
-  ```
-  For lists, subsetting is possible:
-  ```r
-  my_list = list(age = septic_patients$age, gender = septic_patients$gender)
-  my_list %>% freq(age)
-  my_list %>% freq(gender)
-  ```
-
-#### Other
-* More unit tests to ensure better integrity of functions
-
-# AMR 0.3.0
-
-#### New
-* **BREAKING**: `rsi_df` was removed in favour of new functions `portion_R`, `portion_IR`, `portion_I`, `portion_SI` and `portion_S` to selectively calculate resistance or susceptibility. These functions are 20 to 30 times faster than the old `rsi` function. The old function still works, but is deprecated.
-  * New function `portion_df` to get all portions of S, I and R of a data set with antibiotic columns, with support for grouped variables
-* **BREAKING**: the methodology for determining first weighted isolates was changed. The antibiotics that are compared between isolates (call *key antibiotics*) to include more first isolates (afterwards called first *weighted* isolates) are now as follows:
-  * Universal: amoxicillin, amoxicillin/clavlanic acid, cefuroxime, piperacillin/tazobactam, ciprofloxacin,  trimethoprim/sulfamethoxazole
-  * Gram-positive: vancomycin, teicoplanin, tetracycline, erythromycin, oxacillin, rifampicin
-  * Gram-negative: gentamicin, tobramycin, colistin, cefotaxime, ceftazidime, meropenem
-* Support for `ggplot2`
-  * New functions `geom_rsi`, `facet_rsi`, `scale_y_percent`, `scale_rsi_colours` and `theme_rsi`
-  * New wrapper function `ggplot_rsi` to apply all above functions on a data set:
-    * `septic_patients %>% select(tobr, gent) %>% ggplot_rsi` will show portions of S, I and R immediately in a pretty plot
-    * Support for grouped variables, see `?ggplot_rsi`
-* Determining bacterial ID:
-  * New functions `as.bactid` and `is.bactid` to transform/ look up microbial ID's.
-  * The existing function `guess_bactid` is now an alias of `as.bactid`
-  * New Becker classification for *Staphylococcus* to categorise them into Coagulase Negative *Staphylococci* (CoNS) and Coagulase Positve *Staphylococci* (CoPS)
-  * New Lancefield classification for *Streptococcus* to categorise them into Lancefield groups
-* For convience, new descriptive statistical functions `kurtosis` and `skewness` that are lacking in base R - they are generic functions and have support for vectors, data.frames and matrices
-* Function `g.test` to perform the Χ<sup>2</sup> distributed [*G*-test](https://en.wikipedia.org/wiki/G-test), which use is the same as `chisq.test`
-* ~~Function `ratio` to transform a vector of values to a preset ratio~~
-  * ~~For example: `ratio(c(10, 500, 10), ratio = "1:2:1")` would return `130, 260, 130`~~
-* Support for Addins menu in RStudio to quickly insert `%in%` or `%like%` (and give them keyboard shortcuts), or to view the datasets that come with this package
-* Function `p.symbol` to transform p values to their related symbols: `0 '***' 0.001 '**' 0.01 '*' 0.05 '.' 0.1 ' ' 1`
-* Functions `clipboard_import` and `clipboard_export` as helper functions to quickly copy and paste from/to software like Excel and SPSS. These functions use the `clipr` package, but are a little altered to also support headless Linux servers (so you can use it in RStudio Server)
-* New for frequency tables (function `freq`):
-  * A vignette to explain its usage
-  * Support for `rsi` (antimicrobial resistance) to use as input
-  * Support for `table` to use as input: `freq(table(x, y))`
-  * Support for existing functions `hist` and `plot` to use a frequency table as input: `hist(freq(df$age))`
-  * Support for `as.vector`, `as.data.frame`, `as_tibble` and `format`
-  * Support for quasiquotation: `freq(mydata, mycolumn)` is the same as `mydata %>% freq(mycolumn)`
-  * Function `top_freq` function to return the top/below *n* items as vector
-  * Header of frequency tables now also show Mean Absolute Deviaton (MAD) and Interquartile Range (IQR)
-  * Possibility to globally set the default for the amount of items to print, with `options(max.print.freq = n)` where *n* is your preset value
-
-#### Changed
-* Improvements for forecasting with `resistance_predict` and added more examples
-* More antibiotics added as parameters for EUCAST rules
-* Updated version of the `septic_patients` data set to better reflect the reality
-* Pretty printing for tibbles removed as it is not really the scope of this package
-* Printing of `mic` and `rsi` classes now returns all values - use `freq` to check distributions
-* Improved speed of key antibiotics comparison for determining first isolates
-* Column names for the `key_antibiotics` function are now generic: 6 for broadspectrum ABs, 6 for Gram-positive specific and 6 for Gram-negative specific ABs
-* Speed improvement for the `abname` function
-* `%like%` now supports multiple patterns
-* Frequency tables are now actual `data.frame`s with altered console printing to make it look like a frequency table. Because of this, the parameter `toConsole` is not longer needed.
-* Fix for `freq` where the class of an item would be lost
-* Small translational improvements to the `septic_patients` dataset and the column `bactid` now has the new class `"bactid"`
-* Small improvements to the `microorganisms` dataset (especially for *Salmonella*) and the column `bactid` now has the new class `"bactid"`
-* Combined MIC/RSI values will now be coerced by the `rsi` and `mic` functions:
-  * `as.rsi("<=0.002; S")` will return `S`
-  * `as.mic("<=0.002; S")` will return `<=0.002`
-* Now possible to coerce MIC values with a space between operator and value, i.e. `as.mic("<= 0.002")` now works
-* Classes `rsi` and `mic` do not add the attribute `package.version` anymore
-* Added `"groups"` option for `atc_property(..., property)`. It will return a vector of the ATC hierarchy as defined by the [WHO](https://www.whocc.no/atc/structure_and_principles/). The new function `atc_groups` is a convenient wrapper around this.
-* Build-in host check for `atc_property` as it requires the host set by `url` to be responsive
-* Improved `first_isolate` algorithm to exclude isolates where bacteria ID or genus is unavailable
-* Fix for warning *hybrid evaluation forced for row_number* ([`924b62`](https://github.com/tidyverse/dplyr/commit/924b62)) from the `dplyr` package v0.7.5 and above
-* Support for empty values and for 1 or 2 columns as input for `guess_bactid` (now called `as.bactid`)
-  * So `yourdata %>% select(genus, species) %>% as.bactid()` now also works
-* Other small fixes
-
-#### Other
-* Added integration tests (check if everything works as expected) for all releases of R 3.1 and higher
-  * Linux and macOS: https://travis-ci.org/msberends/AMR
-  * Windows: https://ci.appveyor.com/project/msberends/amr
-* Added thesis advisors to DESCRIPTION file
-
-# AMR 0.2.0
-
-#### New
-* Full support for Windows, Linux and macOS
-* Full support for old R versions, only R-3.0.0 (April 2013) or later is needed (needed packages may have other dependencies)
-* Function `n_rsi` to count cases where antibiotic test results were available, to be used in conjunction with `dplyr::summarise`, see ?rsi
-* Function `guess_bactid` to **determine the ID** of a microorganism based on genus/species or known abbreviations like MRSA
-* Function `guess_atc` to **determine the ATC** of an antibiotic based on name, trade name, or known abbreviations
-* Function `freq` to create **frequency tables**, with additional info in a header
-* Function `MDRO` to **determine Multi Drug Resistant Organisms (MDRO)** with support for country-specific guidelines.
-  * [Exceptional resistances defined by EUCAST](http://www.eucast.org/expert_rules_and_intrinsic_resistance) are also supported instead of countries alone
-  * Functions `BRMO` and `MRGN` are wrappers for Dutch and German guidelines, respectively
-* New algorithm to determine weighted isolates, can now be `"points"` or `"keyantibiotics"`, see `?first_isolate`
-* New print format for `tibble`s and `data.table`s
-
-#### Changed
-* Fixed `rsi` class for vectors that contain only invalid antimicrobial interpretations
-* Renamed dataset `ablist` to `antibiotics`
-* Renamed dataset `bactlist` to `microorganisms`
-* Added common abbreviations and trade names to the `antibiotics` dataset
-* Added more microorganisms to the `microorganisms` dataset
-* Added analysis examples on help page of dataset `septic_patients`
-* Added support for character vector in `join` functions
-* Added warnings when a join results in more rows after than before the join
-* Altered `%like%` to make it case insensitive
-* For parameters of functions `first_isolate` and `EUCAST_rules` column names are now case-insensitive
-* Functions `as.rsi` and `as.mic` now add the package name and version as attributes
-
-#### Other
-* Expanded `README.md` with more examples
-* Added [ORCID](https://orcid.org) of authors to DESCRIPTION file
-* Added unit testing with the `testthat` package
-* Added build tests for Linux and macOS using Travis CI (https://travis-ci.org/msberends/AMR)
-* Added line coverage checking using CodeCov (https://codecov.io/gh/msberends/AMR/tree/master/R)
-
-# AMR 0.1.1
-
-* `EUCAST_rules` applies for amoxicillin even if ampicillin is missing
-* Edited column names to comply with GLIMS, the laboratory information system
-* Added more valid MIC values
-* Renamed 'Daily Defined Dose' to 'Defined Daily Dose'
-* Added barplots for `rsi` and `mic` classes
-
-# AMR 0.1.0
-
-* First submission to CRAN.

R/ab.R

@@ -1,384 +0,0 @@
-# ==================================================================== #
-# TITLE                                                                #
-# Antimicrobial Resistance (AMR) Analysis                              #
-#                                                                      #
-# SOURCE                                                               #
-# https://gitlab.com/msberends/AMR                                     #
-#                                                                      #
-# LICENCE                                                              #
-# (c) 2019 Berends MS (m.s.berends@umcg.nl), Luz CF (c.f.luz@umcg.nl)  #
-#                                                                      #
-# This R package is free software; you can freely use and distribute   #
-# it for both personal and commercial purposes under the terms of the  #
-# GNU General Public License version 2.0 (GNU GPL-2), as published by  #
-# the Free Software Foundation.                                        #
-#                                                                      #
-# This R package was created for academic research and was publicly    #
-# released in the hope that it will be useful, but it comes WITHOUT    #
-# ANY WARRANTY OR LIABILITY.                                           #
-# Visit our website for more info: https://msberends.gitlab.io/AMR.    #
-# ==================================================================== #
-
-#' Transform to antibiotic ID
-#'
-#' Use this function to determine the antibiotic code of one or more antibiotics. The data set [antibiotics] will be searched for abbreviations, official names and synonyms (brand names).
-#' @param x character vector to determine to antibiotic ID
-#' @param ... arguments passed on to internal functions
-#' @rdname as.ab
-#' @inheritSection WHOCC WHOCC
-#' @importFrom dplyr %>% filter slice pull
-#' @details All entries in the [antibiotics] data set have three different identifiers: a human readable EARS-Net code (column `ab`, used by ECDC and WHONET), an ATC code (column `atc`, used by WHO), and a CID code (column `cid`, Compound ID, used by PubChem). The data set contains more than 5,000 official brand names from many different countries, as found in PubChem.
-#'
-#' Use the [ab_property()] functions to get properties based on the returned antibiotic ID, see Examples.
-#' @section Source:
-#' World Health Organization (WHO) Collaborating Centre for Drug Statistics Methodology: \url{https://www.whocc.no/atc_ddd_index/}
-#'
-#' WHONET 2019 software: \url{http://www.whonet.org/software.html}
-#'
-#' European Commission Public Health PHARMACEUTICALS - COMMUNITY REGISTER: \url{http://ec.europa.eu/health/documents/community-register/html/atc.htm}
-#' @aliases ab
-#' @return Character (vector) with class [`ab`]. Unknown values will return `NA`.
-#' @seealso [antibiotics] for the dataframe that is being used to determine ATCs.
-#' @inheritSection AMR Read more on our website!
-#' @export
-#' @examples
-#' # These examples all return "ERY", the ID of Erythromycin:
-#' as.ab("J01FA01")
-#' as.ab("J 01 FA 01")
-#' as.ab("Erythromycin")
-#' as.ab("eryt")
-#' as.ab("   eryt 123")
-#' as.ab("ERYT")
-#' as.ab("ERY")
-#' as.ab("eritromicine") # spelled wrong, yet works
-#' as.ab("Erythrocin")   # trade name
-#' as.ab("Romycin")      # trade name
-#'
-#' # Use ab_* functions to get a specific properties (see ?ab_property);
-#' # they use as.ab() internally:
-#' ab_name("J01FA01")    # "Erythromycin"
-#' ab_name("eryt")       # "Erythromycin"
-as.ab <- function(x, ...) {
-  if (is.ab(x)) {
-    return(x)
-  }
-
-  if (all(toupper(x) %in% AMR::antibiotics$ab)) {
-    # valid AB code, but not yet right class
-    return(structure(.Data = toupper(x),
-                     class = "ab"))
-  }
-
-  x_bak <- x
-  # remove diacritics
-  x <- iconv(x, from = "UTF-8", to = "ASCII//TRANSLIT")
-  x <- gsub('"', "", x, fixed = TRUE)
-  # remove suffices
-  x_bak_clean <- gsub("_(mic|rsi|dis[ck])$", "", x, ignore.case = TRUE)
-  # remove disk concentrations, like LVX_NM -> LVX
-  x_bak_clean <- gsub("_[A-Z]{2}[0-9_.]{0,3}$", "", x_bak_clean, ignore.case = TRUE)
-  # remove part between brackets if that's followed by another string
-  x_bak_clean <- gsub("(.*)+ [(].*[)]", "\\1", x_bak_clean)
-  # keep only max 1 space
-  x_bak_clean <- trimws(gsub(" +", " ", x_bak_clean, ignore.case = TRUE))
-  # non-character, space or number should be a slash
-  x_bak_clean <- gsub("[^A-Za-z0-9 -]", "/", x_bak_clean)
-  # spaces around non-characters must be removed: amox + clav -> amox/clav
-  x_bak_clean <- gsub("(.*[a-zA-Z0-9]) ([^a-zA-Z0-9].*)", "\\1\\2", x_bak_clean)
-  x_bak_clean <- gsub("(.*[^a-zA-Z0-9]) ([a-zA-Z0-9].*)", "\\1\\2", x_bak_clean)
-
-  x <- unique(x_bak_clean)
-  x_new <- rep(NA_character_, length(x))
-  x_unknown <- character(0)
-
-  for (i in seq_len(length(x))) {
-    if (is.na(x[i]) | is.null(x[i])) {
-      next
-    }
-    if (identical(x[i], "")) {
-      x_unknown <- c(x_unknown, x_bak[x[i] == x_bak_clean][1])
-      next
-    }
-    # prevent "bacteria" from coercing to TMP, since Bacterial is a brand name of it
-    if (identical(tolower(x[i]), "bacteria")) {
-      x_unknown <- c(x_unknown, x_bak[x[i] == x_bak_clean][1])
-      next
-    }
-
-    # exact AB code
-    found <- AMR::antibiotics[which(AMR::antibiotics$ab == toupper(x[i])), ]$ab
-    if (length(found) > 0) {
-      x_new[i] <- found[1L]
-      next
-    }
-
-    # exact ATC code
-    found <- AMR::antibiotics[which(AMR::antibiotics$atc == toupper(x[i])), ]$ab
-    if (length(found) > 0) {
-      x_new[i] <- found[1L]
-      next
-    }
-
-    # exact CID code
-    found <- AMR::antibiotics[which(AMR::antibiotics$cid == x[i]), ]$ab
-    if (length(found) > 0) {
-      x_new[i] <- found[1L]
-      next
-    }
-
-    # exact name
-    found <- AMR::antibiotics[which(toupper(AMR::antibiotics$name) == toupper(x[i])), ]$ab
-    if (length(found) > 0) {
-      x_new[i] <- found[1L]
-      next
-    }
-
-    # exact synonym
-    synonym_found <- unlist(lapply(AMR::antibiotics$synonyms,
-                                   function(s) if (toupper(x[i]) %in% toupper(s)) {
-                                     TRUE
-                                   } else {
-                                     FALSE
-                                   }))
-    found <- AMR::antibiotics$ab[synonym_found == TRUE]
-    if (length(found) > 0) {
-      x_new[i] <- found[1L]
-      next
-    }
-
-    # exact abbreviation
-    abbr_found <- unlist(lapply(AMR::antibiotics$abbreviations,
-                                function(a) if (toupper(x[i]) %in% toupper(a)) {
-                                  TRUE
-                                } else {
-                                  FALSE
-                                }))
-    found <- AMR::antibiotics$ab[abbr_found == TRUE]
-    if (length(found) > 0) {
-      x_new[i] <- found[1L]
-      next
-    }
-
-    # first >=4 characters of name
-    if (nchar(x[i]) >= 4) {
-      found <- AMR::antibiotics[which(toupper(AMR::antibiotics$name) %like% paste0("^", x[i])), ]$ab
-      if (length(found) > 0) {
-        x_new[i] <- found[1L]
-        next
-      }
-    }
-
-    # allow characters that resemble others, but only continue when having more than 3 characters
-    if (nchar(x[i]) <= 3) {
-      x_unknown <- c(x_unknown, x_bak[x[i] == x_bak_clean][1])
-      next
-    }
-    x_spelling <- tolower(x[i])
-    x_spelling <- gsub("[iy]+", "[iy]+", x_spelling)
-    x_spelling <- gsub("(c|k|q|qu|s|z|x|ks)+", "(c|k|q|qu|s|z|x|ks)+", x_spelling)
-    x_spelling <- gsub("(ph|f|v)+", "(ph|f|v)+", x_spelling)
-    x_spelling <- gsub("(th|t)+", "(th|t)+", x_spelling)
-    x_spelling <- gsub("a+", "a+", x_spelling)
-    x_spelling <- gsub("e+", "e+", x_spelling)
-    x_spelling <- gsub("o+", "o+", x_spelling)
-    # allow any ending of -in/-ine and -im/-ime
-    x_spelling <- gsub("(\\[iy\\]\\+(n|m)|\\[iy\\]\\+(n|m)e\\+)$", "[iy]+(n|m)e*", x_spelling)
-    # allow any ending of -ol/-ole
-    x_spelling <- gsub("(o\\+l|o\\+le\\+)$", "o+le*", x_spelling)
-    # allow any ending of -on/-one
-    x_spelling <- gsub("(o\\+n|o\\+ne\\+)$", "o+ne*", x_spelling)
-    # replace multiple same characters to single one with '+', like "ll" -> "l+"
-    x_spelling <- gsub("(.)\\1+", "\\1+", x_spelling)
-  
-    # try if name starts with it
-    found <- AMR::antibiotics[which(AMR::antibiotics$name %like% paste0("^", x_spelling)), ]$ab
-    if (length(found) > 0) {
-      x_new[i] <- found[1L]
-      next
-    }
-    # and try if any synonym starts with it
-    synonym_found <- unlist(lapply(AMR::antibiotics$synonyms,
-                                   function(s) if (any(s %like% paste0("^", x_spelling))) {
-                                     TRUE
-                                   } else {
-                                     FALSE
-                                   }))
-    found <- AMR::antibiotics$ab[synonym_found == TRUE]
-    if (length(found) > 0) {
-      x_new[i] <- found[1L]
-      next
-    }
-
-    # try by removing all spaces
-    if (x[i] %like% " ") {
-      found <- suppressWarnings(as.ab(gsub(" +", "", x[i])))
-      if (length(found) > 0 & !is.na(found)) {
-        x_new[i] <- found[1L]
-        next
-      }
-    }
-
-    # try by removing all spaces and numbers
-    if (x[i] %like% " " | x[i] %like% "[0-9]") {
-      found <- suppressWarnings(as.ab(gsub("[ 0-9]", "", x[i])))
-      if (length(found) > 0 & !is.na(found)) {
-        x_new[i] <- found[1L]
-        next
-      }
-    }
-    
-    if (!isFALSE(list(...)$initial_search)) {
-      # transform back from other languages and try again
-      x_translated <- paste(lapply(strsplit(x[i], "[^a-zA-Z0-9 ]"),
-                                   function(y) {
-                                     for (i in seq_len(length(y))) {
-                                       y[i] <- ifelse(tolower(y[i]) %in% tolower(translations_file$replacement),
-                                                      translations_file[which(tolower(translations_file$replacement) == tolower(y[i]) &
-                                                                                !isFALSE(translations_file$fixed)), "pattern"],
-                                                      y[i])
-                                     }
-                                     y
-                                   })[[1]],
-                            collapse = "/")
-      x_translated_guess <- suppressWarnings(as.ab(x_translated, initial_search = FALSE))
-      if (!is.na(x_translated_guess)) {
-        x_new[i] <- x_translated_guess
-        next
-      }
-      
-      if (!isFALSE(list(...)$initial_search2)) {
-        # now also try to coerce brandname combinations like "Amoxy/clavulanic acid"
-        x_translated <- paste(lapply(strsplit(x_translated, "[^a-zA-Z0-9 ]"),
-                                     function(y) {
-                                       for (i in seq_len(length(y))) {
-                                         y_name <- suppressWarnings(ab_name(y[i], language = NULL, initial_search = FALSE, initial_search2 = FALSE))
-                                         y[i] <- ifelse(!is.na(y_name),
-                                                        y_name,
-                                                        y[i])
-                                       }
-                                       y
-                                     })[[1]],
-                              collapse = "/")
-        x_translated_guess <- suppressWarnings(as.ab(x_translated, initial_search = FALSE))
-        if (!is.na(x_translated_guess)) {
-          x_new[i] <- x_translated_guess
-          next
-        }
-      }
-    }
-    
-    # not found
-    x_unknown <- c(x_unknown, x_bak[x[i] == x_bak_clean][1])
-  }
-
-  # take failed ATC codes apart from rest
-  x_unknown_ATCs <- x_unknown[x_unknown %like% "[A-Z][0-9][0-9][A-Z][A-Z][0-9][0-9]"]
-  x_unknown <- x_unknown[!x_unknown %in% x_unknown_ATCs]
-  if (length(x_unknown_ATCs) > 0) {
-    warning("These ATC codes are not (yet) in the antibiotics data set: ",
-            paste('"', sort(unique(x_unknown_ATCs)), '"', sep = "", collapse = ", "),
-            ".",
-            call. = FALSE)
-  }
-
-  if (length(x_unknown) > 0) {
-    warning("These values could not be coerced to a valid antimicrobial ID: ",
-            paste('"', sort(unique(x_unknown)), '"', sep = "", collapse = ", "),
-            ".",
-            call. = FALSE)
-  }
-
-  x_result <- data.frame(x = x_bak_clean, stringsAsFactors = FALSE) %>%
-    left_join(data.frame(x = x, x_new = x_new, stringsAsFactors = FALSE), by = "x") %>%
-    pull(x_new)
-
-  if (length(x_result) == 0) {
-    x_result <- NA_character_
-  }
-
-  structure(.Data = x_result,
-            class = "ab")
-}
-
-#' @rdname as.ab
-#' @export
-is.ab <- function(x) {
-  identical(class(x), "ab")
-}
-
-#' @exportMethod print.ab
-#' @export
-#' @noRd
-print.ab <- function(x, ...) {
-  cat("Class 'ab'\n")
-  print(as.character(x), quote = FALSE)
-}
-
-#' @exportMethod as.data.frame.ab
-#' @export
-#' @noRd
-as.data.frame.ab <- function(x, ...) {
-  # same as as.data.frame.character but with removed stringsAsFactors
-  nm <- paste(deparse(substitute(x), width.cutoff = 500L),
-              collapse = " ")
-  if (!"nm" %in% names(list(...))) {
-    as.data.frame.vector(x, ..., nm = nm)
-  } else {
-    as.data.frame.vector(x, ...)
-  }
-}
-
-#' @exportMethod [.ab
-#' @export
-#' @noRd
-"[.ab" <- function(x, ...) {
-  y <- NextMethod()
-  attributes(y) <- attributes(x)
-  y
-}
-#' @exportMethod [[.ab
-#' @export
-#' @noRd
-"[[.ab" <- function(x, ...) {
-  y <- NextMethod()
-  attributes(y) <- attributes(x)
-  y
-}
-#' @exportMethod [<-.ab
-#' @export
-#' @noRd
-"[<-.ab" <- function(i, j, ..., value) {
-  y <- NextMethod()
-  attributes(y) <- attributes(i)
-  class_integrity_check(y, "antimicrobial code", AMR::antibiotics$ab)
-}
-#' @exportMethod [[<-.ab
-#' @export
-#' @noRd
-"[[<-.ab" <- function(i, j, ..., value) {
-  y <- NextMethod()
-  attributes(y) <- attributes(i)
-  class_integrity_check(y, "antimicrobial code", AMR::antibiotics$ab)
-}
-#' @exportMethod c.ab
-#' @export
-#' @noRd
-c.ab <- function(x, ...) {
-  y <- NextMethod()
-  attributes(y) <- attributes(x)
-  class_integrity_check(y, "antimicrobial code", AMR::antibiotics$ab)
-}
-
-#' @importFrom pillar type_sum
-#' @export
-type_sum.ab <- function(x) {
-  "ab"
-}
-
-#' @importFrom pillar pillar_shaft
-#' @export
-pillar_shaft.ab <- function(x, ...) {
-  out <- format(x)
-  out[is.na(x)] <- pillar::style_na("NA")
-  pillar::new_pillar_shaft_simple(out, align = "left", min_width = 4)
-}

R/ab_property.R

@@ -1,206 +0,0 @@
-# ==================================================================== #
-# TITLE                                                                #
-# Antimicrobial Resistance (AMR) Analysis                              #
-#                                                                      #
-# SOURCE                                                               #
-# https://gitlab.com/msberends/AMR                                     #
-#                                                                      #
-# LICENCE                                                              #
-# (c) 2019 Berends MS (m.s.berends@umcg.nl), Luz CF (c.f.luz@umcg.nl)  #
-#                                                                      #
-# This R package is free software; you can freely use and distribute   #
-# it for both personal and commercial purposes under the terms of the  #
-# GNU General Public License version 2.0 (GNU GPL-2), as published by  #
-# the Free Software Foundation.                                        #
-#                                                                      #
-# This R package was created for academic research and was publicly    #
-# released in the hope that it will be useful, but it comes WITHOUT    #
-# ANY WARRANTY OR LIABILITY.                                           #
-# Visit our website for more info: https://msberends.gitlab.io/AMR.    #
-# ==================================================================== #
-
-#' Property of an antibiotic
-#'
-#' Use these functions to return a specific property of an antibiotic from the [antibiotics] data set. All input values will be evaluated internally with [as.ab()].
-#' @param x any (vector of) text that can be coerced to a valid microorganism code with [as.ab()]
-#' @param tolower logical to indicate whether the first character of every output should be transformed to a lower case character. This will lead to e.g. "polymyxin B" and not "polymyxin b".
-#' @param property one of the column names of one of the [antibiotics] data set
-#' @param language language of the returned text, defaults to system language (see [get_locale()]) and can also be set with `getOption("AMR_locale")`. Use `language = NULL` or `language = ""` to prevent translation.
-#' @param administration way of administration, either `"oral"` or `"iv"`
-#' @param units a logical to indicate whether the units instead of the DDDs itself must be returned, see Examples
-#' @param ... other parameters passed on to [as.ab()]
-#' @details All output will be [translate]d where possible.
-#' @inheritSection as.ab Source
-#' @rdname ab_property
-#' @name ab_property
-#' @return 
-#' - An [`integer`] in case of [ab_cid()]
-#' - A named [`list`] in case of [ab_info()] and multiple [ab_synonyms()]/[ab_tradenames()]
-#' - A [`double`] in case of [ab_ddd()]
-#' - A [`character`] in all other cases
-#' @export
-#' @seealso [antibiotics]
-#' @inheritSection AMR Read more on our website!
-#' @examples
-#' # all properties:
-#' ab_name("AMX")       # "Amoxicillin"
-#' ab_atc("AMX")        # J01CA04 (ATC code from the WHO)
-#' ab_cid("AMX")        # 33613 (Compound ID from PubChem)
-#'
-#' ab_synonyms("AMX")   # a list with brand names of amoxicillin
-#' ab_tradenames("AMX") # same
-#'
-#' ab_group("AMX")      # "Beta-lactams/penicillins"
-#' ab_atc_group1("AMX") # "Beta-lactam antibacterials, penicillins"
-#' ab_atc_group2("AMX") # "Penicillins with extended spectrum"
-#'
-#' ab_name(x = c("AMC", "PLB"))  # "Amoxicillin/clavulanic acid" "Polymyxin B"
-#' ab_name(x = c("AMC", "PLB"),
-#'         tolower = TRUE)       # "amoxicillin/clavulanic acid" "polymyxin B"
-#'
-#' ab_ddd("AMX", "oral")               #  1
-#' ab_ddd("AMX", "oral", units = TRUE) # "g"
-#' ab_ddd("AMX", "iv")                 #  1
-#' ab_ddd("AMX", "iv", units = TRUE)   # "g"
-#'
-#' ab_info("AMX")       # all properties as a list
-#'
-#' # all ab_* functions use as.ab() internally:
-#' ab_name("Fluclox")   # "Flucloxacillin"
-#' ab_name("fluklox")   # "Flucloxacillin"
-#' ab_name("floxapen")  # "Flucloxacillin"
-#' ab_name(21319)       # "Flucloxacillin" (using CID)
-#' ab_name("J01CF05")   # "Flucloxacillin" (using ATC)
-ab_name <- function(x, language = get_locale(), tolower = FALSE, ...) {
-  x <- translate_AMR(ab_validate(x = x, property = "name", ...), language = language)
-  if (tolower == TRUE) {
-    # use perl to only transform the first character
-    # as we want "polymyxin B", not "polymyxin b"
-    x <- gsub("^([A-Z])", "\\L\\1", x, perl = TRUE)
-  }
-  x
-}
-
-#' @rdname ab_property
-#' @aliases ATC
-#' @export
-ab_atc <- function(x, ...) {
-  ab_validate(x = x, property = "atc", ...)
-}
-
-#' @rdname ab_property
-#' @export
-ab_cid <- function(x, ...) {
-  ab_validate(x = x, property = "cid", ...)
-}
-
-#' @rdname ab_property
-#' @export
-ab_synonyms <- function(x, ...) {
-  syns <- ab_validate(x = x, property = "synonyms", ...)
-  names(syns) <- x
-  if (length(syns) == 1) {
-    unname(unlist(syns))
-  } else {
-    syns
-  }
-}
-
-#' @rdname ab_property
-#' @export
-ab_tradenames <- function(x, ...) {
-  ab_synonyms(x, ...)
-}
-
-#' @rdname ab_property
-#' @export
-ab_group <- function(x, language = get_locale(), ...) {
-  translate_AMR(ab_validate(x = x, property = "group", ...), language = language)
-}
-
-#' @rdname ab_property
-#' @export
-ab_atc_group1 <- function(x, language = get_locale(), ...) {
-  translate_AMR(ab_validate(x = x, property = "atc_group1", ...), language = language)
-}
-
-#' @rdname ab_property
-#' @export
-ab_atc_group2 <- function(x, language = get_locale(), ...) {
-  translate_AMR(ab_validate(x = x, property = "atc_group2", ...), language = language)
-}
-
-#' @rdname ab_property
-#' @export
-ab_ddd <- function(x, administration = "oral", units = FALSE, ...) {
-  if (!administration %in% c("oral", "iv")) {
-    stop("`administration` must be 'oral' or 'iv'", call. = FALSE)
-  }
-  ddd_prop <- administration
-  if (units == TRUE) {
-    ddd_prop <- paste0(ddd_prop, "_units")
-  } else {
-    ddd_prop <- paste0(ddd_prop, "_ddd")
-  }
-  ab_validate(x = x, property = ddd_prop, ...)
-}
-
-#' @rdname ab_property
-#' @export
-ab_info <- function(x, language = get_locale(), ...) {
-  x <- AMR::as.ab(x, ...)
-  base::list(ab = as.character(x),
-             atc = ab_atc(x),
-             cid = ab_cid(x),
-             name = ab_name(x, language = language),
-             group = ab_group(x, language = language),
-             atc_group1 = ab_atc_group1(x, language = language),
-             atc_group2 = ab_atc_group2(x, language = language),
-             tradenames = ab_tradenames(x),
-             ddd = list(oral = list(amount = ab_ddd(x, administration = "oral", units = FALSE),
-                                    units = ab_ddd(x, administration = "oral", units = TRUE)),
-                        iv = list(amount = ab_ddd(x, administration = "iv", units = FALSE),
-                                  units = ab_ddd(x, administration = "iv", units = TRUE))))
-}
-
-#' @rdname ab_property
-#' @export
-ab_property <- function(x, property = "name", language = get_locale(), ...) {
-  if (length(property) != 1L) {
-    stop("'property' must be of length 1.")
-  }
-  if (!property %in% colnames(AMR::antibiotics)) {
-    stop("invalid property: '", property, "' - use a column name of the `antibiotics` data set")
-  }
-
-  translate_AMR(ab_validate(x = x, property = property, ...), language = language)
-}
-
-ab_validate <- function(x, property, ...) {
-  if (!"AMR" %in% base::.packages()) {
-    library("AMR")
-    # check onLoad() in R/zzz.R: data tables are created there.
-  }
-  
-  # try to catch an error when inputting an invalid parameter
-  # so the 'call.' can be set to FALSE
-  tryCatch(x[1L] %in% AMR::antibiotics[1, property],
-           error = function(e) stop(e$message, call. = FALSE))
-  x_bak <- x
-  if (!all(x %in% AMR::antibiotics[, property])) {
-    x <- data.frame(ab = AMR::as.ab(x, ...), stringsAsFactors = FALSE) %>%
-      left_join(AMR::antibiotics, by = "ab") %>%
-      pull(property)
-  }
-  if (property == "ab") {
-    return(structure(x, class = property))
-  } else if (property == "cid") {
-    return(as.integer(x))
-  } else if (property %like% "ddd") {
-    return(as.double(x))
-  } else {
-    # return "(input)" for NAs
-    x[is.na(x) & !is.na(x_bak)] <- paste0("(", x_bak[is.na(x) & !is.na(x_bak)], ")")
-    return(x)
-  }
-}

R/age.R

@@ -1,192 +0,0 @@
-# ==================================================================== #
-# TITLE                                                                #
-# Antimicrobial Resistance (AMR) Analysis                              #
-#                                                                      #
-# SOURCE                                                               #
-# https://gitlab.com/msberends/AMR                                     #
-#                                                                      #
-# LICENCE                                                              #
-# (c) 2019 Berends MS (m.s.berends@umcg.nl), Luz CF (c.f.luz@umcg.nl)  #
-#                                                                      #
-# This R package is free software; you can freely use and distribute   #
-# it for both personal and commercial purposes under the terms of the  #
-# GNU General Public License version 2.0 (GNU GPL-2), as published by  #
-# the Free Software Foundation.                                        #
-#                                                                      #
-# This R package was created for academic research and was publicly    #
-# released in the hope that it will be useful, but it comes WITHOUT    #
-# ANY WARRANTY OR LIABILITY.                                           #
-# Visit our website for more info: https://msberends.gitlab.io/AMR.    #
-# ==================================================================== #
-
-#' Age in years of individuals
-#'
-#' Calculates age in years based on a reference date, which is the sytem date at default.
-#' @param x date(s), will be coerced with [as.POSIXlt()]
-#' @param reference reference date(s) (defaults to today), will be coerced with [as.POSIXlt()] and cannot be lower than `x`
-#' @param exact a logical to indicate whether age calculation should be exact, i.e. with decimals. It divides the number of days of [year-to-date](https://en.wikipedia.org/wiki/Year-to-date) (YTD) of `x` by the number of days in the year of `reference` (either 365 or 366).
-#' @param na.rm a logical to indicate whether missing values should be removed
-#' @return An integer (no decimals) if `exact = FALSE`, a double (with decimals) otherwise
-#' @seealso To split ages into groups, use the [age_groups()] function.
-#' @importFrom dplyr if_else
-#' @inheritSection AMR Read more on our website!
-#' @export
-#' @examples
-#' # 10 random birth dates
-#' df <- data.frame(birth_date = Sys.Date() - runif(10) * 25000)
-#' # add ages
-#' df$age <- age(df$birth_date)
-#' # add exact ages
-#' df$age_exact <- age(df$birth_date, exact = TRUE)
-#'
-#' df
-age <- function(x, reference = Sys.Date(), exact = FALSE, na.rm = FALSE) {
-  if (length(x) != length(reference)) {
-    if (length(reference) == 1) {
-      reference <- rep(reference, length(x))
-    } else {
-      stop("`x` and `reference` must be of same length, or `reference` must be of length 1.")
-    }
-  }
-  x <- as.POSIXlt(x)
-  reference <- as.POSIXlt(reference)
-
-  # from https://stackoverflow.com/a/25450756/4575331
-  years_gap <- reference$year - x$year
-  ages <- if_else(reference$mon < x$mon | (reference$mon == x$mon & reference$mday < x$mday),
-                  as.integer(years_gap - 1),
-                  as.integer(years_gap))
-
-  # add decimals
-  if (exact == TRUE) {
-    # get dates of `x` when `x` would have the year of `reference`
-    x_in_reference_year <- as.POSIXlt(paste0(format(reference, "%Y"), format(x, "-%m-%d")))
-    # get differences in days
-    n_days_x_rest <- as.double(difftime(reference, x_in_reference_year, units = "days"))
-    # get numbers of days the years of `reference` has for a reliable denominator
-    n_days_reference_year <- as.POSIXlt(paste0(format(reference, "%Y"), "-12-31"))$yday + 1
-    # add decimal parts of year
-    mod <- n_days_x_rest / n_days_reference_year
-    # negative mods are cases where `x_in_reference_year` > `reference` - so 'add' a year
-    mod[mod < 0] <- 1 + mod[mod < 0]
-    # and finally add to ages
-    ages <- ages + mod
-  }
-
-  if (any(ages < 0, na.rm = TRUE)) {
-    ages[ages < 0] <- NA
-    warning("NAs introduced for ages below 0.")
-  }
-  if (any(ages > 120, na.rm = TRUE)) {
-    warning("Some ages are above 120.")
-  }
-  
-  if (isTRUE(na.rm)) {
-    ages <- ages[!is.na(ages)]
-  }
-
-  ages
-}
-
-#' Split ages into age groups
-#'
-#' Split ages into age groups defined by the `split` parameter. This allows for easier demographic (antimicrobial resistance) analysis.
-#' @param x age, e.g. calculated with [age()]
-#' @param split_at values to split `x` at, defaults to age groups 0-11, 12-24, 25-54, 55-74 and 75+. See Details.
-#' @param na.rm a logical to indicate whether missing values should be removed
-#' @details To split ages, the input can be:
-#' 
-#' * A numeric vector. A vector of e.g. `c(10, 20)` will split on 0-9, 10-19 and 20+. A value of only `50` will split on 0-49 and 50+.
-#'   The default is to split on young children (0-11), youth (12-24), young adults (25-54), middle-aged adults (55-74) and elderly (75+).
-#' * A character:
-#'   - `"children"` or `"kids"`, equivalent of: `c(0, 1, 2, 4, 6, 13, 18)`. This will split on 0, 1, 2-3, 4-5, 6-12, 13-17 and 18+.
-#'   - `"elderly"` or `"seniors"`, equivalent of: `c(65, 75, 85)`. This will split on 0-64, 65-74, 75-84, 85+.
-#'   - `"fives"`, equivalent of: `1:20 * 5`. This will split on 0-4, 5-9, 10-14, ..., 90-94, 95-99, 100+.
-#'   - `"tens"`, equivalent of: `1:10 * 10`. This will split on 0-9, 10-19, 20-29, ... 80-89, 90-99, 100+.
-#' @return Ordered [`factor`]
-#' @seealso To determine ages, based on one or more reference dates, use the [age()] function.
-#' @export
-#' @inheritSection AMR Read more on our website!
-#' @examples
-#' ages <- c(3, 8, 16, 54, 31, 76, 101, 43, 21)
-#'
-#' # split into 0-49 and 50+
-#' age_groups(ages, 50)
-#'
-#' # split into 0-19, 20-49 and 50+
-#' age_groups(ages, c(20, 50))
-#'
-#' # split into groups of ten years
-#' age_groups(ages, 1:10 * 10)
-#' age_groups(ages, split_at = "tens")
-#'
-#' # split into groups of five years
-#' age_groups(ages, 1:20 * 5)
-#' age_groups(ages, split_at = "fives")
-#'
-#' # split specifically for children
-#' age_groups(ages, "children")
-#' # same:
-#' age_groups(ages, c(1, 2, 4, 6, 13, 17))
-#'
-#' \dontrun{
-#' # resistance of ciprofloxacine per age group
-#' library(dplyr)
-#' example_isolates %>%
-#'   filter_first_isolate() %>%
-#'   filter(mo == as.mo("E. coli")) %>%
-#'   group_by(age_group = age_groups(age)) %>%
-#'   select(age_group, CIP) %>%
-#'   ggplot_rsi(x = "age_group")
-#' }
-age_groups <- function(x, split_at = c(12, 25, 55, 75), na.rm = FALSE) {
-  if (!is.numeric(x)) {
-    stop("`x` and must be numeric, not a ", paste0(class(x), collapse = "/"), ".")
-  }
-  if (any(x < 0, na.rm = TRUE)) {
-    x[x < 0] <- NA
-    warning("NAs introduced for ages below 0.")
-  }
-  if (is.character(split_at)) {
-    split_at <- split_at[1L]
-    if (split_at %like% "^(child|kid|junior)") {
-      split_at <- c(0, 1, 2, 4, 6, 13, 18)
-    } else if (split_at %like% "^(elder|senior)") {
-      split_at <-  c(65, 75, 85)
-    } else if (split_at %like% "^five") {
-      split_at <- 1:20 * 5
-    } else if (split_at %like% "^ten") {
-      split_at <- 1:10 * 10
-    }
-  }
-  split_at <- sort(unique(as.integer(split_at)))
-  if (!split_at[1] == 0) {
-    # add base number 0
-    split_at <- c(0, split_at)
-  }
-  split_at <- split_at[!is.na(split_at)]
-  if (length(split_at) == 1) {
-    # only 0 is available
-    stop("invalid value for `split_at`.")
-  }
-
-  # turn input values to 'split_at' indices
-  y <- x
-  labs <- split_at
-  for (i in seq_len(length(split_at))) {
-    y[x >= split_at[i]] <- i
-    # create labels
-    labs[i - 1] <- paste0(unique(c(split_at[i - 1], split_at[i] - 1)), collapse = "-")
-  }
-
-  # last category
-  labs[length(labs)] <- paste0(split_at[length(split_at)], "+")
-
-  agegroups <- factor(labs[y], levels = labs, ordered = TRUE)
-  
-  if (isTRUE(na.rm)) {
-    agegroups <- agegroups[!is.na(agegroups)]
-  }
-  
-  agegroups
-}

R/amr.R

@@ -1,62 +0,0 @@
-# ==================================================================== #
-# TITLE                                                                #
-# Antimicrobial Resistance (AMR) Analysis                              #
-#                                                                      #
-# SOURCE                                                               #
-# https://gitlab.com/msberends/AMR                                     #
-#                                                                      #
-# LICENCE                                                              #
-# (c) 2019 Berends MS (m.s.berends@umcg.nl), Luz CF (c.f.luz@umcg.nl)  #
-#                                                                      #
-# This R package is free software; you can freely use and distribute   #
-# it for both personal and commercial purposes under the terms of the  #
-# GNU General Public License version 2.0 (GNU GPL-2), as published by  #
-# the Free Software Foundation.                                        #
-#                                                                      #
-# This R package was created for academic research and was publicly    #
-# released in the hope that it will be useful, but it comes WITHOUT    #
-# ANY WARRANTY OR LIABILITY.                                           #
-# Visit our website for more info: https://msberends.gitlab.io/AMR.    #
-# ==================================================================== #
-
-#' The `AMR` Package
-#'
-#' Welcome to the `AMR` package.
-#' @details
-#' `AMR` is a free and open-source R package to simplify the analysis and prediction of Antimicrobial Resistance (AMR) and to work with microbial and antimicrobial properties by using evidence-based methods. It supports any table format, including WHONET/EARS-Net data.
-#'
-#' We created this package for both academic research and routine analysis at the Faculty of Medical Sciences of the University of Groningen and the Medical Microbiology & Infection Prevention (MMBI) department of the University Medical Center Groningen (UMCG). This R package is actively maintained and free software; you can freely use and distribute it for both personal and commercial (but not patent) purposes under the terms of the GNU General Public License version 2.0 (GPL-2), as published by the Free Software Foundation.
-#'
-#' This package can be used for:
-#' - Reference for the taxonomy of microorganisms, since the package contains all microbial (sub)species from the [Catalogue of Life](http://www.catalogueoflife.org)
-#' - Interpreting raw MIC and disk diffusion values, based on the latest CLSI or EUCAST guidelines
-#' - Determining first isolates to be used for AMR analysis
-#' - Calculating antimicrobial resistance
-#' - Determining multi-drug resistance (MDR) / multi-drug resistant organisms (MDRO)
-#' - Calculating (empirical) susceptibility of both mono therapy and combination therapies
-#' - Predicting future antimicrobial resistance using regression models
-#' - Getting properties for any microorganism (like Gram stain, species, genus or family)
-#' - Getting properties for any antibiotic (like name, EARS-Net code, ATC code, PubChem code, defined daily dose or trade name)
-#' - Plotting antimicrobial resistance
-#' - Applying EUCAST expert rules
-
-#' @section Read more on our website!:
-#' On our website <https://msberends.gitlab.io/AMR> you can find [a tutorial](https://msberends.gitlab.io/AMR/articles/AMR.html) about how to conduct AMR analysis, the [complete documentation of all functions](https://msberends.gitlab.io/AMR/reference) (which reads a lot easier than here in R) and [an example analysis using WHONET data](https://msberends.gitlab.io/AMR/articles/WHONET.html).
-#' @section Contact us:
-#' For suggestions, comments or questions, please contact us at:
-#'
-#' Matthijs S. Berends \cr
-#' m.s.berends at umcg dot nl \cr
-#' Department of Medical Microbiology, University of Groningen \cr
-#' University Medical Center Groningen \cr
-#' Post Office Box 30001 \cr
-#' 9700 RB Groningen \cr
-#' The Netherlands
-#'
-#' If you have found a bug, please file a new issue at: \cr
-#' <https://gitlab.com/msberends/AMR/issues>
-#' @name AMR
-#' @rdname AMR
-#' @importFrom microbenchmark microbenchmark
-#' @importFrom knitr kable
-NULL

R/atc_online.R

@@ -1,197 +0,0 @@
-# ==================================================================== #
-# TITLE                                                                #
-# Antimicrobial Resistance (AMR) Analysis                              #
-#                                                                      #
-# SOURCE                                                               #
-# https://gitlab.com/msberends/AMR                                     #
-#                                                                      #
-# LICENCE                                                              #
-# (c) 2019 Berends MS (m.s.berends@umcg.nl), Luz CF (c.f.luz@umcg.nl)  #
-#                                                                      #
-# This R package is free software; you can freely use and distribute   #
-# it for both personal and commercial purposes under the terms of the  #
-# GNU General Public License version 2.0 (GNU GPL-2), as published by  #
-# the Free Software Foundation.                                        #
-#                                                                      #
-# This R package was created for academic research and was publicly    #
-# released in the hope that it will be useful, but it comes WITHOUT    #
-# ANY WARRANTY OR LIABILITY.                                           #
-# Visit our website for more info: https://msberends.gitlab.io/AMR.    #
-# ==================================================================== #
-
-#' Get ATC properties from WHOCC website
-#'
-#' @description Gets data from the WHO to determine properties of an ATC (e.g. an antibiotic) like name, defined daily dose (DDD) or standard unit.
-#' 
-#' **This function requires an internet connection.**
-#' @param atc_code a character or character vector with ATC code(s) of antibiotic(s)
-#' @param property property of an ATC code. Valid values are `"ATC"`, `"Name"`, `"DDD"`, `"U"` (`"unit"`), `"Adm.R"`, `"Note"` and `groups`. For this last option, all hierarchical groups of an ATC code will be returned, see Examples.
-#' @param administration type of administration when using `property = "Adm.R"`, see Details
-#' @param url url of website of the WHO. The sign `%s` can be used as a placeholder for ATC codes.
-#' @param ... parameters to pass on to `atc_property`
-#' @details
-#' Options for parameter `administration`:
-#' 
-#' - `"Implant"` = Implant
-#' - `"Inhal"` = Inhalation
-#' - `"Instill"` = Instillation
-#' - `"N"` = nasal
-#' - `"O"` = oral
-#' - `"P"` = parenteral
-#' - `"R"` = rectal
-#' - `"SL"` = sublingual/buccal
-#' - `"TD"` = transdermal
-#' - `"V"` = vaginal
-#'
-#' Abbreviations of return values when using `property = "U"` (unit):
-#' 
-#' - `"g"` = gram
-#' - `"mg"` = milligram
-#' - `"mcg"`` = microgram
-#' - `"U"` = unit
-#' - `"TU"` = thousand units
-#' - `"MU"` = million units
-#' - `"mmol"` = millimole
-#' - `"ml"` = milliliter (e.g. eyedrops)
-#' @export
-#' @rdname atc_online
-#' @importFrom dplyr %>% progress_estimated
-#' @inheritSection AMR Read more on our website!
-#' @source <https://www.whocc.no/atc_ddd_alterations__cumulative/ddd_alterations/abbrevations/>
-#' @examples
-#' \donttest{
-#' # oral DDD (Defined Daily Dose) of amoxicillin
-#' atc_online_property("J01CA04", "DDD", "O")
-#' # parenteral DDD (Defined Daily Dose) of amoxicillin
-#' atc_online_property("J01CA04", "DDD", "P")
-#'
-#' atc_online_property("J01CA04", property = "groups") # search hierarchical groups of amoxicillin
-#' # [1] "ANTIINFECTIVES FOR SYSTEMIC USE"
-#' # [2] "ANTIBACTERIALS FOR SYSTEMIC USE"
-#' # [3] "BETA-LACTAM ANTIBACTERIALS, PENICILLINS"
-#' # [4] "Penicillins with extended spectrum"
-#' }
-atc_online_property <- function(atc_code,
-                                property,
-                                administration = "O",
-                                url = "https://www.whocc.no/atc_ddd_index/?code=%s&showdescription=no") {
-
-  if (!all(c("curl", "rvest", "xml2") %in% rownames(utils::installed.packages()))) {
-    stop("Packages 'xml2', 'rvest' and 'curl' are required for this function")
-  }
-
-  if (!all(atc_code %in% AMR::antibiotics)) {
-    atc_code <- as.character(ab_atc(atc_code))
-  }
-
-  if (!curl::has_internet()) {
-    message("There appears to be no internet connection.")
-    return(rep(NA, length(atc_code)))
-  }
-
-  if (length(property) != 1L) {
-    stop("`property` must be of length 1", call. = FALSE)
-  }
-  if (length(administration) != 1L) {
-    stop("`administration` must be of length 1", call. = FALSE)
-  }
-
-  # also allow unit as property
-  if (property %like% "unit") {
-    property <- "U"
-  }
-
-  # validation of properties
-  valid_properties <- c("ATC", "Name", "DDD", "U", "Adm.R", "Note", "groups")
-  valid_properties.bak <- valid_properties
-
-  property <- tolower(property)
-  valid_properties <- tolower(valid_properties)
-
-  if (!property %in% valid_properties) {
-    stop("Invalid `property`, use one of ", paste(valid_properties.bak, collapse = ", "), ".")
-  }
-
-  if (property == "ddd") {
-    returnvalue <- rep(NA_real_, length(atc_code))
-  } else if (property == "groups") {
-    returnvalue <- list()
-  } else {
-    returnvalue <- rep(NA_character_, length(atc_code))
-  }
-
-  progress <- progress_estimated(n = length(atc_code))
-
-  for (i in seq_len(length(atc_code))) {
-
-    progress$tick()$print()
-
-    atc_url <- sub("%s", atc_code[i], url, fixed = TRUE)
-
-    if (property == "groups") {
-      tbl <- xml2::read_html(atc_url) %>%
-        rvest::html_node("#content") %>%
-        rvest::html_children() %>%
-        rvest::html_node("a")
-
-      # get URLS of items
-      hrefs <- tbl %>% rvest::html_attr("href")
-      # get text of items
-      texts <- tbl %>% rvest::html_text()
-      # select only text items where URL like "code="
-      texts <- texts[grepl("?code=", tolower(hrefs), fixed = TRUE)]
-      # last one is antibiotics, skip it
-      texts <- texts[seq_len(length(texts)) - 1]
-      returnvalue <- c(list(texts), returnvalue)
-
-    } else {
-      tbl <- xml2::read_html(atc_url) %>%
-        rvest::html_nodes("table") %>%
-        rvest::html_table(header = TRUE) %>%
-        as.data.frame(stringsAsFactors = FALSE)
-
-      # case insensitive column names
-      colnames(tbl) <- tolower(colnames(tbl)) %>% gsub("^atc.*", "atc", .)
-
-      if (length(tbl) == 0) {
-        warning("ATC not found: ", atc_code[i], ". Please check ", atc_url, ".", call. = FALSE)
-        returnvalue[i] <- NA
-        next
-      }
-
-      if (property %in% c("atc", "name")) {
-        # ATC and name are only in first row
-        returnvalue[i] <- tbl[1, property]
-      } else {
-        if (!"adm.r" %in% colnames(tbl) | is.na(tbl[1, "adm.r"])) {
-          returnvalue[i] <- NA
-          next
-        } else {
-          for (j in seq_len(nrow(tbl))) {
-            if (tbl[j, "adm.r"] == administration) {
-              returnvalue[i] <- tbl[j, property]
-            }
-          }
-        }
-      }
-    }
-  }
-
-  if (property == "groups" & length(returnvalue) == 1) {
-    returnvalue <- returnvalue[[1]]
-  }
-
-  returnvalue
-}
-
-#' @rdname atc_online
-#' @export
-atc_online_groups <- function(atc_code, ...) {
-  atc_online_property(atc_code = atc_code, property = "groups", ...)
-}
-
-#' @rdname atc_online
-#' @export
-atc_online_ddd <- function(atc_code, ...) {
-  atc_online_property(atc_code = atc_code, property = "ddd", ...)
-}

R/availability.R

@@ -1,92 +0,0 @@
-# ==================================================================== #
-# TITLE                                                                #
-# Antimicrobial Resistance (AMR) Analysis                              #
-#                                                                      #
-# SOURCE                                                               #
-# https://gitlab.com/msberends/AMR                                     #
-#                                                                      #
-# LICENCE                                                              #
-# (c) 2019 Berends MS (m.s.berends@umcg.nl), Luz CF (c.f.luz@umcg.nl)  #
-#                                                                      #
-# This R package is free software; you can freely use and distribute   #
-# it for both personal and commercial purposes under the terms of the  #
-# GNU General Public License version 2.0 (GNU GPL-2), as published by  #
-# the Free Software Foundation.                                        #
-#                                                                      #
-# This R package was created for academic research and was publicly    #
-# released in the hope that it will be useful, but it comes WITHOUT    #
-# ANY WARRANTY OR LIABILITY.                                           #
-# Visit our website for more info: https://msberends.gitlab.io/AMR.    #
-# ==================================================================== #
-
-#' Check availability of columns
-#'
-#' Easy check for availability of columns in a data set. This makes it easy to get an idea of which antimicrobial combination can be used for calculation with e.g. [resistance()].
-#' @param tbl a [`data.frame`] or [`list`]
-#' @param width number of characters to present the visual availability, defaults to filling the width of the console
-#' @details The function returns a [`data.frame`] with columns `"resistant"` and `"visual_resistance"`. The values in that columns are calculated with [resistance()].
-#' @return [`data.frame`] with column names of `tbl` as row names
-#' @inheritSection AMR Read more on our website!
-#' @importFrom cleaner percentage
-#' @export
-#' @examples
-#' availability(example_isolates)
-#'
-#' library(dplyr)
-#' example_isolates %>% availability()
-#'
-#' example_isolates %>%
-#'   select_if(is.rsi) %>%
-#'   availability()
-#'
-#' example_isolates %>%
-#'   filter(mo == as.mo("E. coli")) %>%
-#'   select_if(is.rsi) %>%
-#'   availability()
-availability <- function(tbl, width = NULL) {
-  x <- base::sapply(tbl, function(x) {
-    1 - base::sum(base::is.na(x)) / base::length(x) 
-  })
-  n <- base::sapply(tbl, function(x) base::length(x[!base::is.na(x)]))
-  R <- base::sapply(tbl, function(x) base::ifelse(is.rsi(x), resistance(x, minimum = 0), NA))
-  R_print <- character(length(R))
-  R_print[!is.na(R)] <- percentage(R[!is.na(R)])
-  R_print[is.na(R)] <- ""
-
-  if (is.null(width)) {
-    width <- options()$width -
-      (max(nchar(colnames(tbl))) +
-         # count col
-         8 +
-         # available % column
-         10 +
-         # resistant % column
-         10 +
-         # extra margin
-         5)
-    width <- width / 2
-  }
-
-  if (length(R[is.na(R)]) == ncol(tbl)) {
-    width <- width * 2 + 10
-  }
-
-  x_chars_R <- strrep("#", round(width * R, digits = 2))
-  x_chars_SI <- strrep("-", width - nchar(x_chars_R))
-  vis_resistance <- paste0("|", x_chars_R, x_chars_SI, "|")
-  vis_resistance[is.na(R)] <- ""
-
-  x_chars <- strrep("#", round(x, digits = 2) / (1 / width))
-  x_chars_empty <- strrep("-", width - nchar(x_chars))
-
-  df <- data.frame(count = n,
-                   available = percentage(x),
-                   visual_availabilty = paste0("|", x_chars, x_chars_empty, "|"),
-                   resistant = R_print,
-                   visual_resistance = vis_resistance)
-  if (length(R[is.na(R)]) == ncol(tbl)) {
-    df[, 1:3]
-  } else {
-    df
-  }
-}

R/bug_drug_combinations.R

@@ -1,176 +0,0 @@
-# ==================================================================== #
-# TITLE                                                                #
-# Antimicrobial Resistance (AMR) Analysis                              #
-#                                                                      #
-# SOURCE                                                               #
-# https://gitlab.com/msberends/AMR                                     #
-#                                                                      #
-# LICENCE                                                              #
-# (c) 2019 Berends MS (m.s.berends@umcg.nl), Luz CF (c.f.luz@umcg.nl)  #
-#                                                                      #
-# This R package is free software; you can freely use and distribute   #
-# it for both personal and commercial purposes under the terms of the  #
-# GNU General Public License version 2.0 (GNU GPL-2), as published by  #
-# the Free Software Foundation.                                        #
-#                                                                      #
-# This R package was created for academic research and was publicly    #
-# released in the hope that it will be useful, but it comes WITHOUT    #
-# ANY WARRANTY OR LIABILITY.                                           #
-# Visit our website for more info: https://msberends.gitlab.io/AMR.    #
-# ==================================================================== #
-
-#' Determine bug-drug combinations
-#' 
-#' Determine antimicrobial resistance (AMR) of all bug-drug combinations in your data set where at least 30 (default) isolates are available per species. Use [format()] on the result to prettify it to a publicable/printable format, see Examples.
-#' @inheritParams eucast_rules
-#' @param combine_IR logical to indicate whether values R and I should be summed
-#' @param add_ab_group logical to indicate where the group of the antimicrobials must be included as a first column
-#' @param remove_intrinsic_resistant logical to indicate that rows with 100% resistance for all tested antimicrobials must be removed from the table
-#' @param FUN the function to call on the `mo` column to transform the microorganism IDs, defaults to [mo_shortname()] 
-#' @param translate_ab a character of length 1 containing column names of the [antibiotics] data set
-#' @param ... arguments passed on to `FUN`
-#' @inheritParams rsi_df
-#' @inheritParams base::formatC
-#' @importFrom dplyr %>% rename group_by select mutate filter summarise ungroup
-#' @importFrom tidyr pivot_longer
-#' @details The function [format()] calculates the resistance per bug-drug combination. Use `combine_IR = FALSE` (default) to test R vs. S+I and `combine_IR = TRUE` to test R+I vs. S. 
-#' 
-#' The language of the output can be overwritten with `options(AMR_locale)`, please see [translate].
-#' @export
-#' @rdname bug_drug_combinations
-#' @return The function [bug_drug_combinations()] returns a [`data.frame`] with columns "mo", "ab", "S", "I", "R" and "total".
-#' @source \strong{M39 Analysis and Presentation of Cumulative Antimicrobial Susceptibility Test Data, 4th Edition}, 2014, *Clinical and Laboratory Standards Institute (CLSI)*. <https://clsi.org/standards/products/microbiology/documents/m39/>.
-#' @inheritSection AMR Read more on our website!
-#' @examples 
-#' \donttest{
-#' x <- bug_drug_combinations(example_isolates)
-#' x
-#' format(x, translate_ab = "name (atc)")
-#' 
-#' # Use FUN to change to transformation of microorganism codes
-#' x <- bug_drug_combinations(example_isolates, 
-#'                            FUN = mo_gramstain)
-#'                            
-#' x <- bug_drug_combinations(example_isolates,
-#'                            FUN = function(x) ifelse(x == "B_ESCHR_COLI",
-#'                                                     "E. coli",
-#'                                                     "Others"))
-#' }
-bug_drug_combinations <- function(x, 
-                                  col_mo = NULL, 
-                                  FUN = mo_shortname,
-                                  ...) {
-  if (!is.data.frame(x)) {
-    stop("`x` must be a data frame.", call. = FALSE)
-  }
-  
-  # try to find columns based on type
-  # -- mo
-  if (is.null(col_mo)) {
-    col_mo <- search_type_in_df(x = x, type = "mo")
-  }
-  if (is.null(col_mo)) {
-    stop("`col_mo` must be set.", call. = FALSE)
-  }
-  
-  x <- x %>%
-    as.data.frame(stringsAsFactors = FALSE) %>% 
-    mutate(mo = x %>% 
-             pull(col_mo) %>% 
-             FUN(...)) %>% 
-    group_by(mo) %>% 
-    select_if(is.rsi) %>% 
-    pivot_longer(-mo, names_to = "ab") %>% 
-    group_by(mo, ab) %>% 
-    summarise(S = sum(value == "S", na.rm = TRUE),
-              I = sum(value == "I", na.rm = TRUE),
-              R = sum(value == "R", na.rm = TRUE)) %>%
-    ungroup() %>%
-    mutate(total = S + I + R) %>%
-    as.data.frame(stringsAsFactors = FALSE)
-
-  structure(.Data = x, class = c("bug_drug_combinations", class(x)))
-}
-
-#' @importFrom dplyr everything rename %>% ungroup group_by summarise mutate_all arrange everything lag
-#' @importFrom tidyr pivot_wider
-#' @importFrom cleaner percentage
-#' @exportMethod format.bug_drug_combinations
-#' @export
-#' @rdname bug_drug_combinations
-format.bug_drug_combinations <- function(x,
-                                         translate_ab = "name (ab, atc)",
-                                         language = get_locale(),
-                                         minimum = 30,
-                                         combine_SI = TRUE,
-                                         combine_IR = FALSE,
-                                         add_ab_group = TRUE,
-                                         remove_intrinsic_resistant = FALSE,
-                                         decimal.mark = getOption("OutDec"),
-                                         big.mark = ifelse(decimal.mark == ",", ".", ","),
-                                         ...) {
-  x <- x %>% filter(total >= minimum)
-  
-  if (remove_intrinsic_resistant == TRUE) {
-    x <- x %>% filter(R != total)
-  }
-  if (combine_SI == TRUE | combine_IR == FALSE) {
-    x$isolates <- x$R
-  } else {
-    x$isolates <- x$R + x$I
-  }
-  
-  give_ab_name <- function(ab, format, language) {
-    format <- tolower(format)
-    ab_txt <- rep(format, length(ab))
-    for (i in seq_len(length(ab_txt))) {
-      ab_txt[i] <- gsub("ab", ab[i], ab_txt[i])
-      ab_txt[i] <- gsub("cid", ab_cid(ab[i]), ab_txt[i])
-      ab_txt[i] <- gsub("group", ab_group(ab[i], language = language), ab_txt[i])
-      ab_txt[i] <- gsub("atc_group1", ab_atc_group1(ab[i], language = language), ab_txt[i])
-      ab_txt[i] <- gsub("atc_group2", ab_atc_group2(ab[i], language = language), ab_txt[i])
-      ab_txt[i] <- gsub("atc", ab_atc(ab[i]), ab_txt[i])
-      ab_txt[i] <- gsub("name", ab_name(ab[i], language = language), ab_txt[i])
-      ab_txt[i]
-    }
-    ab_txt
-  }
-  
-  y <- x %>%
-    mutate(ab = as.ab(ab),
-           ab_txt = give_ab_name(ab = ab, format = translate_ab, language = language)) %>% 
-    group_by(ab, ab_txt, mo) %>% 
-    summarise(isolates = sum(isolates, na.rm = TRUE),
-              total = sum(total, na.rm = TRUE)) %>% 
-    ungroup() %>% 
-    mutate(txt = paste0(percentage(isolates / total, decimal.mark = decimal.mark, big.mark = big.mark), 
-                        " (", trimws(format(isolates, big.mark = big.mark)), "/", 
-                        trimws(format(total, big.mark = big.mark)), ")")) %>% 
-    select(ab, ab_txt, mo, txt) %>%
-    arrange(mo) %>% 
-    pivot_wider(names_from = mo, values_from = txt) %>% 
-    mutate_all(~ifelse(is.na(.), "", .)) %>% 
-    mutate(ab_group = ab_group(ab, language = language),
-           ab_txt) %>% 
-    select(ab_group, ab_txt, everything(), -ab) %>% 
-    arrange(ab_group, ab_txt) %>% 
-    mutate(ab_group = ifelse(ab_group != lag(ab_group) | is.na(lag(ab_group)), ab_group, ""))
-  
-  if (add_ab_group == FALSE) {
-    y <- y %>% select(-ab_group) %>% rename("Drug" = ab_txt)
-    colnames(y)[1] <- translate_AMR(colnames(y)[1], language = get_locale(), only_unknown = FALSE)
-  } else {
-    y <- y %>% rename("Group" = ab_group,
-                      "Drug" = ab_txt)
-    colnames(y)[1:2] <- translate_AMR(colnames(y)[1:2], language = get_locale(), only_unknown = FALSE)
-  }
-  y
-}
-
-#' @exportMethod print.bug_drug_combinations
-#' @export
-#' @importFrom crayon blue
-print.bug_drug_combinations <- function(x, ...) {
-  print(as.data.frame(x, stringsAsFactors = FALSE))
-  message(blue("NOTE: Use 'format()' on this result to get a publicable/printable format."))
-}

R/catalogue_of_life.R

@@ -1,129 +0,0 @@
-# ==================================================================== #
-# TITLE                                                                #
-# Antimicrobial Resistance (AMR) Analysis                              #
-#                                                                      #
-# SOURCE                                                               #
-# https://gitlab.com/msberends/AMR                                     #
-#                                                                      #
-# LICENCE                                                              #
-# (c) 2019 Berends MS (m.s.berends@umcg.nl), Luz CF (c.f.luz@umcg.nl)  #
-#                                                                      #
-# This R package is free software; you can freely use and distribute   #
-# it for both personal and commercial purposes under the terms of the  #
-# GNU General Public License version 2.0 (GNU GPL-2), as published by  #
-# the Free Software Foundation.                                        #
-#                                                                      #
-# This R package was created for academic research and was publicly    #
-# released in the hope that it will be useful, but it comes WITHOUT    #
-# ANY WARRANTY OR LIABILITY.                                           #
-# Visit our website for more info: https://msberends.gitlab.io/AMR.    #
-# ==================================================================== #
-
-#' The Catalogue of Life
-#'
-#' This package contains the complete taxonomic tree of almost all microorganisms from the authoritative and comprehensive Catalogue of Life.
-#' @section Catalogue of Life:
-#' \if{html}{\figure{logo_col.png}{options: height=40px style=margin-bottom:5px} \cr}
-#' This package contains the complete taxonomic tree of almost all microorganisms (~70,000 species) from the authoritative and comprehensive Catalogue of Life (<http://www.catalogueoflife.org>). The Catalogue of Life is the most comprehensive and authoritative global index of species currently available.
-#'
-#' [Click here][catalogue_of_life] for more information about the included taxa. Check which version of the Catalogue of Life was included in this package with [catalogue_of_life_version()].
-#' @section Included taxa:
-#' Included are:
-#' - All ~61,000 (sub)species from the kingdoms of Archaea, Bacteria, Chromista and Protozoa
-#' - All ~8,500 (sub)species from these orders of the kingdom of Fungi: Eurotiales, Microascales, Mucorales, Onygenales, Pneumocystales, Saccharomycetales, Schizosaccharomycetales and Tremellales. The kingdom of Fungi is a very large taxon with almost 300,000 different (sub)species, of which most are not microbial (but rather macroscopic, like mushrooms). Because of this, not all fungi fit the scope of this package and including everything would tremendously slow down our algorithms too. By only including the aforementioned taxonomic orders, the most relevant fungi are covered (like all species of *Aspergillus*, *Candida*, *Cryptococcus*, *Histplasma*, *Pneumocystis*, *Saccharomyces* and *Trichophyton*).
-#' - All ~150 (sub)species from ~100 other relevant genera from the kingdom of Animalia (like *Strongyloides* and *Taenia*)
-#' - All ~23,000 previously accepted names of all included (sub)species (these were taxonomically renamed)
-#' - The complete taxonomic tree of all included (sub)species: from kingdom to subspecies
-#' - The responsible author(s) and year of scientific publication
-#'
-#' The Catalogue of Life (<http://www.catalogueoflife.org>) is the most comprehensive and authoritative global index of species currently available. It holds essential information on the names, relationships and distributions of over 1.9 million species. The Catalogue of Life is used to support the major biodiversity and conservation information services such as the Global Biodiversity Information Facility (GBIF), Encyclopedia of Life (EoL) and the International Union for Conservation of Nature Red List. It is recognised by the Convention on Biological Diversity as a significant component of the Global Taxonomy Initiative and a contribution to Target 1 of the Global Strategy for Plant Conservation.
-#'
-#' The syntax used to transform the original data to a cleansed R format, can be found here: <https://gitlab.com/msberends/AMR/blob/master/data-raw/reproduction_of_microorganisms.R>.
-#' @inheritSection AMR Read more on our website!
-#' @name catalogue_of_life
-#' @rdname catalogue_of_life
-#' @seealso Data set [microorganisms] for the actual data. \cr
-#' Function [as.mo()] to use the data for intelligent determination of microorganisms.
-#' @examples
-#' # Get version info of included data set
-#' catalogue_of_life_version()
-#'
-#'
-#' # Get a note when a species was renamed
-#' mo_shortname("Chlamydia psittaci")
-#' # Note: 'Chlamydia psittaci' (Page, 1968) was renamed
-#' #       'Chlamydophila psittaci' (Everett et al., 1999)
-#' # [1] "C. psittaci"
-#'
-#' # Get any property from the entire taxonomic tree for all included species
-#' mo_class("E. coli")
-#' # [1] "Gammaproteobacteria"
-#'
-#' mo_family("E. coli")
-#' # [1] "Enterobacteriaceae"
-#'
-#' mo_gramstain("E. coli") # based on kingdom and phylum, see ?mo_gramstain
-#' # [1] "Gram negative"
-#'
-#' mo_ref("E. coli")
-#' # [1] "Castellani et al., 1919"
-#'
-#' # Do not get mistaken - this package is about microorganisms
-#' mo_kingdom("C. elegans")
-#' # [1] "Bacteria"                        # Bacteria?!
-#' mo_name("C. elegans")
-#' # [1] "Chroococcus limneticus elegans"  # Because a microorganism was found
-NULL
-
-#' Version info of included Catalogue of Life
-#'
-#' This function returns information about the included data from the Catalogue of Life.
-#' @seealso [microorganisms]
-#' @details For DSMZ, see [microorganisms].
-#' @return a [`list`], which prints in pretty format
-#' @inheritSection catalogue_of_life Catalogue of Life
-#' @inheritSection AMR Read more on our website!
-#' @importFrom crayon bold underline
-#' @importFrom dplyr filter
-#' @export
-#' @examples
-#' library(dplyr)
-#' microorganisms %>% freq(kingdom)
-#' microorganisms %>% group_by(kingdom) %>% freq(phylum, nmax = NULL)
-catalogue_of_life_version <- function() {
-  # see the `catalogue_of_life` list in R/data.R
-  lst <- list(catalogue_of_life =
-                list(version = gsub("{year}", catalogue_of_life$year, catalogue_of_life$version, fixed = TRUE),
-                     url = gsub("{year}", catalogue_of_life$year, catalogue_of_life$url_CoL, fixed = TRUE),
-                     n = nrow(filter(AMR::microorganisms, source == "CoL"))),
-              deutsche_sammlung_von_mikroorganismen_und_zellkulturen =
-                list(version = "Prokaryotic Nomenclature Up-to-Date from DSMZ",
-                     url = catalogue_of_life$url_DSMZ,
-                     yearmonth = catalogue_of_life$yearmonth_DSMZ,
-                     n = nrow(filter(AMR::microorganisms, source == "DSMZ"))),
-              total_included =
-                list(
-                  n_total_species = nrow(AMR::microorganisms),
-                  n_total_synonyms = nrow(AMR::microorganisms.old)))
-
-  structure(.Data = lst,
-            class = c("catalogue_of_life_version", "list"))
-}
-
-#' @exportMethod print.catalogue_of_life_version
-#' @export
-#' @noRd
-print.catalogue_of_life_version <- function(x, ...) {
-  lst <- x
-  cat(paste0(bold("Included in this AMR package are:\n\n"),
-             underline(lst$catalogue_of_life$version), "\n",
-             "  Available at: ", lst$catalogue_of_life$url, "\n",
-             "  Number of included species: ", format(lst$catalogue_of_life$n, big.mark = ","), "\n",
-             underline(paste0(lst$deutsche_sammlung_von_mikroorganismen_und_zellkulturen$version, " (",
-                              lst$deutsche_sammlung_von_mikroorganismen_und_zellkulturen$yearmonth, ")")), "\n",
-             "  Available at: ", lst$deutsche_sammlung_von_mikroorganismen_und_zellkulturen$url, "\n",
-             "  Number of included species: ", format(lst$deutsche_sammlung_von_mikroorganismen_und_zellkulturen$n, big.mark = ","), "\n\n",
-             "=> Total number of species included:  ", format(lst$total_included$n_total_species, big.mark = ","), "\n",
-             "=> Total number of synonyms included: ", format(lst$total_included$n_total_synonyms, big.mark = ","), "\n\n",
-             "See for more info ?microorganisms and ?catalogue_of_life.\n"))
-}

R/count.R

@@ -1,194 +0,0 @@
-# ==================================================================== #
-# TITLE                                                                #
-# Antimicrobial Resistance (AMR) Analysis                              #
-#                                                                      #
-# SOURCE                                                               #
-# https://gitlab.com/msberends/AMR                                     #
-#                                                                      #
-# LICENCE                                                              #
-# (c) 2019 Berends MS (m.s.berends@umcg.nl), Luz CF (c.f.luz@umcg.nl)  #
-#                                                                      #
-# This R package is free software; you can freely use and distribute   #
-# it for both personal and commercial purposes under the terms of the  #
-# GNU General Public License version 2.0 (GNU GPL-2), as published by  #
-# the Free Software Foundation.                                        #
-#                                                                      #
-# This R package was created for academic research and was publicly    #
-# released in the hope that it will be useful, but it comes WITHOUT    #
-# ANY WARRANTY OR LIABILITY.                                           #
-# Visit our website for more info: https://msberends.gitlab.io/AMR.    #
-# ==================================================================== #
-
-#' Count available isolates
-#'
-#' @description These functions can be used to count resistant/susceptible microbial isolates. All functions support quasiquotation with pipes, can be used in [summarise()] and support grouped variables, see *Examples*.
-#'
-#' [count_resistant()] should be used to count resistant isolates, [count_susceptible()] should be used to count susceptible isolates.
-#' @param ... one or more vectors (or columns) with antibiotic interpretations. They will be transformed internally with [as.rsi()] if needed.
-#' @inheritParams proportion
-#' @inheritSection as.rsi Interpretation of R and S/I
-#' @details These functions are meant to count isolates. Use the [resistance()]/[susceptibility()] functions to calculate microbial resistance/susceptibility.
-#' 
-#' The function [count_resistant()] is equal to the function [count_R()]. The function [count_susceptible()] is equal to the function [count_SI()].
-#'
-#' The function [n_rsi()] is an alias of [count_all()]. They can be used to count all available isolates, i.e. where all input antibiotics have an available result (S, I or R). Their use is equal to [n_distinct()]. Their function is equal to `count_susceptible(...) + count_resistant(...)`.
-#'
-#' The function [count_df()] takes any variable from `data` that has an [`rsi`] class (created with [as.rsi()]) and counts the number of S's, I's and R's. The function [rsi_df()] works exactly like [count_df()], but adds the percentage of S, I and R.
-#' @inheritSection proportion Combination therapy
-#' @seealso [`proportion_*`][proportion] to calculate microbial resistance and susceptibility.
-#' @return An [`integer`]
-#' @rdname count
-#' @name count
-#' @export
-#' @inheritSection AMR Read more on our website!
-#' @examples
-#' # example_isolates is a data set available in the AMR package.
-#' ?example_isolates
-#' 
-#' count_resistant(example_isolates$AMX)   # counts "R"
-#' count_susceptible(example_isolates$AMX) # counts "S" and "I"
-#' count_all(example_isolates$AMX)         # counts "S", "I" and "R"
-#'
-#' # be more specific
-#' count_S(example_isolates$AMX)
-#' count_SI(example_isolates$AMX)
-#' count_I(example_isolates$AMX)
-#' count_IR(example_isolates$AMX)
-#' count_R(example_isolates$AMX)
-#'
-#' # Count all available isolates
-#' count_all(example_isolates$AMX)
-#' n_rsi(example_isolates$AMX)
-#'
-#' # n_rsi() is an alias of count_all().
-#' # Since it counts all available isolates, you can
-#' # calculate back to count e.g. susceptible isolates.
-#' # These results are the same:
-#' count_susceptible(example_isolates$AMX)
-#' susceptibility(example_isolates$AMX) * n_rsi(example_isolates$AMX)
-#'
-#' library(dplyr)
-#' example_isolates %>%
-#'   group_by(hospital_id) %>%
-#'   summarise(R  = count_R(CIP),
-#'             I  = count_I(CIP),
-#'             S  = count_S(CIP),
-#'             n1 = count_all(CIP),  # the actual total; sum of all three
-#'             n2 = n_rsi(CIP),      # same - analogous to n_distinct
-#'             total = n())          # NOT the number of tested isolates!
-#'
-#' # Count co-resistance between amoxicillin/clav acid and gentamicin,
-#' # so we can see that combination therapy does a lot more than mono therapy.
-#' # Please mind that `susceptibility()` calculates percentages right away instead.
-#' example_isolates %>% count_susceptible(AMC) # 1433
-#' example_isolates %>% count_all(AMC)         # 1879
-#'
-#' example_isolates %>% count_susceptible(GEN) # 1399
-#' example_isolates %>% count_all(GEN)         # 1855
-#'
-#' example_isolates %>% count_susceptible(AMC, GEN) # 1764
-#' example_isolates %>% count_all(AMC, GEN)         # 1936
-
-#' # Get number of S+I vs. R immediately of selected columns
-#' example_isolates %>%
-#'   select(AMX, CIP) %>%
-#'   count_df(translate = FALSE)
-#'
-#' # It also supports grouping variables
-#' example_isolates %>%
-#'   select(hospital_id, AMX, CIP) %>%
-#'   group_by(hospital_id) %>%
-#'   count_df(translate = FALSE)
-#'
-count_resistant <- function(..., only_all_tested = FALSE) {
-  rsi_calc(...,
-           ab_result = "R",
-           only_all_tested = only_all_tested,
-           only_count = TRUE)
-}
-
-#' @rdname count
-#' @export
-count_susceptible <- function(..., only_all_tested = FALSE) {
-  rsi_calc(...,
-           ab_result = c("S", "I"),
-           only_all_tested = only_all_tested,
-           only_count = TRUE)
-}
-
-#' @rdname count
-#' @export
-count_R <- function(..., only_all_tested = FALSE) {
-  rsi_calc(...,
-           ab_result = "R",
-           only_all_tested = only_all_tested,
-           only_count = TRUE)
-}
-
-#' @rdname count
-#' @export
-count_IR <- function(..., only_all_tested = FALSE) {
-  warning("Using 'count_IR' is discouraged; use 'count_resistant()' instead to not consider \"I\" being resistant.", call. = FALSE)
-  rsi_calc(...,
-           ab_result = c("I", "R"),
-           only_all_tested = only_all_tested,
-           only_count = TRUE)
-}
-
-#' @rdname count
-#' @export
-count_I <- function(..., only_all_tested = FALSE) {
-  rsi_calc(...,
-           ab_result = "I",
-           only_all_tested = only_all_tested,
-           only_count = TRUE)
-}
-
-#' @rdname count
-#' @export
-count_SI <- function(..., only_all_tested = FALSE) {
-  rsi_calc(...,
-           ab_result = c("S", "I"),
-           only_all_tested = only_all_tested,
-           only_count = TRUE)
-}
-
-#' @rdname count
-#' @export
-count_S <- function(..., only_all_tested = FALSE) {
-  warning("Using 'count_S' is discouraged; use 'count_susceptible()' instead to also consider \"I\" being susceptible.", call. = FALSE)
-  rsi_calc(...,
-           ab_result = "S",
-           only_all_tested = only_all_tested,
-           only_count = TRUE)
-}
-
-#' @rdname count
-#' @export
-count_all <- function(..., only_all_tested = FALSE) {
-  rsi_calc(...,
-           ab_result = c("S", "I", "R"),
-           only_all_tested = only_all_tested,
-           only_count = TRUE)
-}
-
-#' @rdname count
-#' @export
-n_rsi <- count_all
-
-#' @rdname count
-#' @export
-count_df <- function(data,
-                     translate_ab = "name",
-                     language = get_locale(),
-                     combine_SI = TRUE,
-                     combine_IR = FALSE) {
-
-  rsi_calc_df(type = "count",
-              data = data,
-              translate_ab = translate_ab,
-              language = language,
-              combine_SI = combine_SI,
-              combine_IR = combine_IR,
-              combine_SI_missing = missing(combine_SI))
-}

R/data.R

@@ -1,225 +0,0 @@
-# ==================================================================== #
-# TITLE                                                                #
-# Antimicrobial Resistance (AMR) Analysis                              #
-#                                                                      #
-# SOURCE                                                               #
-# https://gitlab.com/msberends/AMR                                     #
-#                                                                      #
-# LICENCE                                                              #
-# (c) 2019 Berends MS (m.s.berends@umcg.nl), Luz CF (c.f.luz@umcg.nl)  #
-#                                                                      #
-# This R package is free software; you can freely use and distribute   #
-# it for both personal and commercial purposes under the terms of the  #
-# GNU General Public License version 2.0 (GNU GPL-2), as published by  #
-# the Free Software Foundation.                                        #
-#                                                                      #
-# This R package was created for academic research and was publicly    #
-# released in the hope that it will be useful, but it comes WITHOUT    #
-# ANY WARRANTY OR LIABILITY.                                           #
-# Visit our website for more info: https://msberends.gitlab.io/AMR.    #
-# ==================================================================== #
-
-#' Data sets with ~550 antimicrobials
-#'
-#' Two data sets containing all antibiotics/antimycotics and antivirals. Use [as.ab()] or one of the [ab_property()] functions to retrieve values from the [antibiotics] data set. Three identifiers are included in this data set: an antibiotic ID (`ab`, primarily used in this package) as defined by WHONET/EARS-Net, an ATC code (`atc`) as defined by the WHO, and a Compound ID (`cid`) as found in PubChem. Other properties in this data set are derived from one or more of these codes.
-#' @format
-#' ### For the [antibiotics] data set: a [`data.frame`] with 452 observations and 13 variables:
-#' - `ab`\cr Antibiotic ID as used in this package (like `AMC`), using the official EARS-Net (European Antimicrobial Resistance Surveillance Network) codes where available
-#' - `atc`\cr ATC code (Anatomical Therapeutic Chemical) as defined by the WHOCC, like `J01CR02`
-#' - `cid`\cr Compound ID as found in PubChem
-#' - `name`\cr Official name as used by WHONET/EARS-Net or the WHO
-#' - `group`\cr A short and concise group name, based on WHONET and WHOCC definitions
-#' - `atc_group1`\cr Official pharmacological subgroup (3rd level ATC code) as defined by the WHOCC, like `"Macrolides, lincosamides and streptogramins"`
-#' - `atc_group2`\cr Official chemical subgroup (4th level ATC code) as defined by the WHOCC, like `"Macrolides"`
-#' - `abbr`\cr List of abbreviations as used in many countries, also for antibiotic susceptibility testing (AST)
-#' - `synonyms`\cr Synonyms (often trade names) of a drug, as found in PubChem based on their compound ID
-#' - `oral_ddd`\cr Defined Daily Dose (DDD), oral treatment
-#' - `oral_units`\cr Units of `oral_ddd`
-#' - `iv_ddd`\cr Defined Daily Dose (DDD), parenteral treatment
-#' - `iv_units`\cr Units of `iv_ddd`
-#' 
-#' ### For the [antivirals] data set: a [`data.frame`] with 102 observations and 9 variables:
-#' - `atc`\cr ATC code (Anatomical Therapeutic Chemical) as defined by the WHOCC
-#' - `cid`\cr Compound ID as found in PubChem
-#' - `name`\cr Official name as used by WHONET/EARS-Net or the WHO
-#' - `atc_group`\cr Official pharmacological subgroup (3rd level ATC code) as defined by the WHOCC
-#' - `synonyms`\cr Synonyms (often trade names) of a drug, as found in PubChem based on their compound ID
-#' - `oral_ddd`\cr Defined Daily Dose (DDD), oral treatment
-#' - `oral_units`\cr Units of `oral_ddd`
-#' - `iv_ddd`\cr Defined Daily Dose (DDD), parenteral treatment
-#' - `iv_units`\cr Units of `iv_ddd`
-#' @details Properties that are based on an ATC code are only available when an ATC is available. These properties are: `atc_group1`, `atc_group2`, `oral_ddd`, `oral_units`, `iv_ddd` and `iv_units`.
-#'
-#' Synonyms (i.e. trade names) are derived from the Compound ID (`cid`) and consequently only available where a CID is available.
-#' @source World Health Organization (WHO) Collaborating Centre for Drug Statistics Methodology (WHOCC): <https://www.whocc.no/atc_ddd_index/>
-#'
-#' WHONET 2019 software: <http://www.whonet.org/software.html>
-#'
-#' European Commission Public Health PHARMACEUTICALS - COMMUNITY REGISTER: <http://ec.europa.eu/health/documents/community-register/html/atc.htm>
-#' @inheritSection WHOCC WHOCC
-#' @inheritSection AMR Read more on our website!
-#' @seealso [microorganisms]
-"antibiotics"
-
-#' @rdname antibiotics
-"antivirals"
-
-#' Data set with ~70,000 microorganisms
-#'
-#' A data set containing the microbial taxonomy of six kingdoms from the Catalogue of Life. MO codes can be looked up using [as.mo()].
-#' @inheritSection catalogue_of_life Catalogue of Life
-#' @format A [`data.frame`] with 69,447 observations and 16 variables:
-#' - `mo`\cr ID of microorganism as used by this package
-#' - `col_id`\cr Catalogue of Life ID
-#' - `fullname`\cr Full name, like `"Escherichia coli"`
-#' - `kingdom`, `phylum`, `class`, `order`, `family`, `genus`, `species`, `subspecies`\cr Taxonomic rank of the microorganism
-#' - `rank`\cr Text of the taxonomic rank of the microorganism, like `"species"` or `"genus"`
-#' - `ref`\cr Author(s) and year of concerning scientific publication
-#' - `species_id`\cr ID of the species as used by the Catalogue of Life
-#' - `source`\cr Either "CoL", "DSMZ" (see Source) or "manually added"
-#' - `prevalence`\cr Prevalence of the microorganism, see [as.mo()]
-#' @details Manually added were:
-#' - 11 entries of *Streptococcus* (beta-haemolytic: groups A, B, C, D, F, G, H, K and unspecified; other: viridans, milleri)
-#' - 2 entries of *Staphylococcus* (coagulase-negative (CoNS) and coagulase-positive (CoPS))
-#' - 3 entries of *Trichomonas* (*Trichomonas vaginalis*, and its family and genus)
-#' - 1 entry of *Blastocystis* (*Blastocystis hominis*), although it officially does not exist (Noel *et al.* 2005, PMID 15634993)
-#' - 5 other 'undefined' entries (unknown, unknown Gram negatives, unknown Gram positives, unknown yeast and unknown fungus)
-#' - 6 families under the Enterobacterales order, according to Adeolu *et al.* (2016, PMID 27620848), that are not in the Catalogue of Life
-#' - 12,600 species from the DSMZ (Deutsche Sammlung von Mikroorganismen und Zellkulturen) since the DSMZ contain the latest taxonomic information based on recent publications
-#' @section About the records from DSMZ (see source):
-#' Names of prokaryotes are defined as being validly published by the International Code of Nomenclature of Bacteria. Validly published are all names which are included in the Approved Lists of Bacterial Names and the names subsequently published in the International Journal of Systematic Bacteriology (IJSB) and, from January 2000, in the International Journal of Systematic and Evolutionary Microbiology (IJSEM) as original articles or in the validation lists.
-#'
-#' From: <https://www.dsmz.de/support/bacterial-nomenclature-up-to-date-downloads/readme.html>
-#' @source Catalogue of Life: Annual Checklist (public online taxonomic database), <http://www.catalogueoflife.org> (check included annual version with [catalogue_of_life_version()]).
-#'
-#' Leibniz Institute DSMZ-German Collection of Microorganisms and Cell Cultures, Germany, Prokaryotic Nomenclature Up-to-Date, <http://www.dsmz.de/bacterial-diversity/prokaryotic-nomenclature-up-to-date> (check included version with [catalogue_of_life_version()]).
-#' @inheritSection AMR Read more on our website!
-#' @seealso [as.mo()], [mo_property()], [microorganisms.codes]
-"microorganisms"
-
-catalogue_of_life <- list(
-  year = 2018,
-  version = "Catalogue of Life: {year} Annual Checklist",
-  url_CoL = "http://www.catalogueoflife.org/annual-checklist/{year}/",
-  url_DSMZ = "https://www.dsmz.de/services/online-tools/prokaryotic-nomenclature-up-to-date/prokaryotic-nomenclature-up-to-date/genus-search",
-  yearmonth_DSMZ = "August 2019"
-)
-
-#' Data set with previously accepted taxonomic names
-#'
-#' A data set containing old (previously valid or accepted) taxonomic names according to the Catalogue of Life. This data set is used internally by [as.mo()].
-#' @inheritSection catalogue_of_life Catalogue of Life
-#' @format A [`data.frame`] with 24,246 observations and 5 variables:
-#' - `col_id`\cr Catalogue of Life ID that was originally given
-#' - `col_id_new`\cr New Catalogue of Life ID that responds to an entry in the [microorganisms] data set
-#' - `fullname`\cr Old full taxonomic name of the microorganism
-#' - `ref`\cr Author(s) and year of concerning scientific publication
-#' - `prevalence`\cr Prevalence of the microorganism, see [as.mo()]
-#' @source Catalogue of Life: Annual Checklist (public online taxonomic database), <http://www.catalogueoflife.org> (check included annual version with [catalogue_of_life_version()]).
-#' @inheritSection AMR Read more on our website!
-#' @seealso [as.mo()] [mo_property()] [microorganisms]
-"microorganisms.old"
-
-#' Translation table for common microorganism codes
-#'
-#' A data set containing commonly used codes for microorganisms, from laboratory systems and WHONET. Define your own with [set_mo_source()].
-#' @format A [`data.frame`] with 5,433 observations and 2 variables:
-#' - `code`\cr Commonly used code of a microorganism
-#' - `mo`\cr ID of the microorganism in the [microorganisms] data set
-#' @inheritSection catalogue_of_life Catalogue of Life
-#' @inheritSection AMR Read more on our website!
-#' @seealso [as.mo()] [microorganisms]
-"microorganisms.codes"
-
-#' Data set with 2,000 example isolates
-#'
-#' A data set containing 2,000 microbial isolates with their full antibiograms. The data set reflects reality and can be used to practice AMR analysis. For examples, please read [the tutorial on our website](https://msberends.gitlab.io/AMR/articles/AMR.html).
-#' @format A [`data.frame`] with 2,000 observations and 49 variables:
-#' - `date`\cr date of receipt at the laboratory
-#' - `hospital_id`\cr ID of the hospital, from A to D
-#' - `ward_icu`\cr logical to determine if ward is an intensive care unit
-#' - `ward_clinical`\cr logical to determine if ward is a regular clinical ward
-#' - `ward_outpatient`\cr logical to determine if ward is an outpatient clinic
-#' - `age`\cr age of the patient
-#' - `gender`\cr gender of the patient
-#' - `patient_id`\cr ID of the patient
-#' - `mo`\cr ID of microorganism created with [as.mo()], see also [microorganisms]
-#' - `PEN:RIF`\cr 40 different antibiotics with class [`rsi`] (see [as.rsi()]); these column names occur in [antibiotics] data set and can be translated with [ab_name()]
-#' @inheritSection AMR Read more on our website!
-"example_isolates"
-
-#' Data set with 500 isolates - WHONET example
-#'
-#' This example data set has the exact same structure as an export file from WHONET. Such files can be used with this package, as this example data set shows. The data itself was based on our [example_isolates] data set.
-#' @format A [`data.frame`] with 500 observations and 53 variables:
-#' - `Identification number`\cr ID of the sample
-#' - `Specimen number`\cr ID of the specimen
-#' - `Organism`\cr Name of the microorganism. Before analysis, you should transform this to a valid microbial class, using [as.mo()].
-#' - `Country`\cr Country of origin
-#' - `Laboratory`\cr Name of laboratory
-#' - `Last name`\cr Last name of patient
-#' - `First name`\cr Initial of patient
-#' - `Sex`\cr Gender of patient
-#' - `Age`\cr Age of patient
-#' - `Age category`\cr Age group, can also be looked up using [age_groups()]
-#' - `Date of admission`\cr Date of hospital admission
-#' - `Specimen date`\cr Date when specimen was received at laboratory
-#' - `Specimen type`\cr Specimen type or group
-#' - `Specimen type (Numeric)`\cr Translation of `"Specimen type"`
-#' - `Reason`\cr Reason of request with Differential Diagnosis
-#' - `Isolate number`\cr ID of isolate
-#' - `Organism type`\cr Type of microorganism, can also be looked up using [mo_type()]
-#' - `Serotype`\cr Serotype of microorganism
-#' - `Beta-lactamase`\cr Microorganism produces beta-lactamase?
-#' - `ESBL`\cr Microorganism produces extended spectrum beta-lactamase?
-#' - `Carbapenemase`\cr Microorganism produces carbapenemase?
-#' - `MRSA screening test`\cr Microorganism is possible MRSA?
-#' - `Inducible clindamycin resistance`\cr Clindamycin can be induced?
-#' - `Comment`\cr Other comments
-#' - `Date of data entry`\cr Date this data was entered in WHONET
-#' - `AMP_ND10:CIP_EE`\cr 27 different antibiotics. You can lookup the abbreviatons in the [antibiotics] data set, or use e.g. [`ab_name("AMP")`][ab_name()] to get the official name immediately. Before analysis, you should transform this to a valid antibiotic class, using [as.rsi()].
-#' @inheritSection AMR Read more on our website!
-"WHONET"
-
-#' Data set for RSI interpretation
-#'
-#' Data set to interpret MIC and disk diffusion to RSI values. Included guidelines are CLSI (2011-2019) and EUCAST (2011-2019). Use [as.rsi()] to transform MICs or disks measurements to RSI values.
-#' @format A [`data.frame`] with 13,975 observations and 9 variables:
-#' - `guideline`\cr Name of the guideline
-#' - `method`\cr Either "MIC" or "DISK"
-#' - `site`\cr Body site, e.g. "Oral" or "Respiratory"
-#' - `mo`\cr Microbial ID, see [as.mo()]
-#' - `ab`\cr Antibiotic ID, see [as.ab()]
-#' - `ref_tbl`\cr Info about where the guideline rule can be found
-#' - `disk_dose`\cr Dose of the used disk diffusion method
-#' - `breakpoint_S`\cr Lowest MIC value or highest number of millimeters that leads to "S"
-#' - `breakpoint_R`\cr Highest MIC value or lowest number of millimeters that leads to "R"
-#' @inheritSection AMR Read more on our website!
-"rsi_translation"
-
-# transforms data set to data.frame with only ASCII values, to comply with CRAN policies
-dataset_UTF8_to_ASCII <- function(df) {
-  trans <- function(vect) {
-    iconv(vect, from = "UTF-8", to = "ASCII//TRANSLIT")
-  }
-  df <- as.data.frame(df, stringsAsFactors = FALSE)
-  for (i in seq_len(NCOL(df))) {
-    col <- df[, i]
-    if (is.list(col)) {
-      for (j in seq_len(length(col))) {
-        col[[j]] <- trans(col[[j]])
-      }
-      df[, i] <- list(col)
-    } else {
-      if (is.factor(col)) {
-        levels(col) <- trans(levels(col))
-      } else if (is.character(col)) {
-        col <- trans(col)
-      } else {
-        col
-      }
-      df[, i] <- col
-    }
-  }
-  df
-}

R/deprecated.R

@@ -1,75 +0,0 @@
-# ==================================================================== #
-# TITLE                                                                #
-# Antimicrobial Resistance (AMR) Analysis                              #
-#                                                                      #
-# SOURCE                                                               #
-# https://gitlab.com/msberends/AMR                                     #
-#                                                                      #
-# LICENCE                                                              #
-# (c) 2019 Berends MS (m.s.berends@umcg.nl), Luz CF (c.f.luz@umcg.nl)  #
-#                                                                      #
-# This R package is free software; you can freely use and distribute   #
-# it for both personal and commercial purposes under the terms of the  #
-# GNU General Public License version 2.0 (GNU GPL-2), as published by  #
-# the Free Software Foundation.                                        #
-#                                                                      #
-# This R package was created for academic research and was publicly    #
-# released in the hope that it will be useful, but it comes WITHOUT    #
-# ANY WARRANTY OR LIABILITY.                                           #
-# Visit our website for more info: https://msberends.gitlab.io/AMR.    #
-# ==================================================================== #
-
-#' Deprecated functions
-#'
-#' These functions are so-called '[Deprecated]'. They will be removed in a future release. Using the functions will give a warning with the name of the function it has been replaced by (if there is one).
-#' @inheritSection AMR Read more on our website!
-#' @export
-#' @keywords internal
-#' @name AMR-deprecated
-#' @rdname AMR-deprecated
-p.symbol <- function(...) {
-  .Deprecated("p_symbol()", package = "AMR")
-  AMR::p_symbol(...)
-}
-
-#' @rdname AMR-deprecated
-#' @export
-portion_R <- function(...) {
-  .Deprecated("resistance()", package = "AMR")
-  proportion_R(...)
-}
-
-#' @rdname AMR-deprecated
-#' @export
-portion_IR <- function(...) {
-  .Deprecated("proportion_IR()", package = "AMR")
-  proportion_IR(...)
-}
-
-#' @rdname AMR-deprecated
-#' @export
-portion_I <- function(...) {
-  .Deprecated("proportion_I()", package = "AMR")
-  proportion_I(...)
-}
-
-#' @rdname AMR-deprecated
-#' @export
-portion_SI <- function(...) {
-  .Deprecated("susceptibility()", package = "AMR")
-  proportion_SI(...)
-}
-
-#' @rdname AMR-deprecated
-#' @export
-portion_S <- function(...) {
-  .Deprecated("proportion_S()", package = "AMR")
-  proportion_S(...)
-}
-
-#' @rdname AMR-deprecated
-#' @export
-portion_df <- function(...) {
-  .Deprecated("proportion_df()", package = "AMR")
-  proportion_df(...)
-}

R/disk.R

@@ -1,106 +0,0 @@
-# ==================================================================== #
-# TITLE                                                                #
-# Antimicrobial Resistance (AMR) Analysis                              #
-#                                                                      #
-# SOURCE                                                               #
-# https://gitlab.com/msberends/AMR                                     #
-#                                                                      #
-# LICENCE                                                              #
-# (c) 2019 Berends MS (m.s.berends@umcg.nl), Luz CF (c.f.luz@umcg.nl)  #
-#                                                                      #
-# This R package is free software; you can freely use and distribute   #
-# it for both personal and commercial purposes under the terms of the  #
-# GNU General Public License version 2.0 (GNU GPL-2), as published by  #
-# the Free Software Foundation.                                        #
-#                                                                      #
-# This R package was created for academic research and was publicly    #
-# released in the hope that it will be useful, but it comes WITHOUT    #
-# ANY WARRANTY OR LIABILITY.                                           #
-# Visit our website for more info: https://msberends.gitlab.io/AMR.    #
-# ==================================================================== #
-
-#' Class 'disk'
-#'
-#' This transforms a vector to a new class [`disk`], which is a growth zone size (around an antibiotic disk) in millimeters between 6 and 99.
-#' @rdname as.disk
-#' @param x vector
-#' @param na.rm a logical indicating whether missing values should be removed
-#' @details Interpret disk values as RSI values with [as.rsi()]. It supports guidelines from EUCAST and CLSI.
-#' @return Ordered integer factor with new class [`disk`]
-#' @aliases disk
-#' @export
-#' @seealso [as.rsi()]
-#' @inheritSection AMR Read more on our website!
-#' @examples
-#' # interpret disk values
-#' as.rsi(x = 12,
-#'        mo = as.mo("S. pneumoniae"),
-#'        ab = "AMX",
-#'        guideline = "EUCAST")
-#' as.rsi(x = 12,
-#'        mo = as.mo("S. pneumoniae"),
-#'        ab = "AMX",
-#'        guideline = "CLSI")
-as.disk <- function(x, na.rm = FALSE) {
-  if (is.disk(x)) {
-    x
-  } else {
-    x <- x %>% unlist()
-    if (na.rm == TRUE) {
-      x <- x[!is.na(x)]
-    }
-    x.bak <- x
-
-    na_before <- length(x[is.na(x)])
-
-    # force it to be integer
-    x <- suppressWarnings(as.integer(x))
-
-    # disks can never be less than 9 mm (size of a disk) or more than 50 mm
-    x[x < 6 | x > 99] <- NA_integer_
-    na_after <- length(x[is.na(x)])
-
-    if (na_before != na_after) {
-      list_missing <- x.bak[is.na(x) & !is.na(x.bak)] %>%
-        unique() %>%
-        sort()
-      list_missing <- paste0('"', list_missing, '"', collapse = ", ")
-      warning(na_after - na_before, " results truncated (",
-              round(((na_after - na_before) / length(x)) * 100),
-              "%) that were invalid disk zones: ",
-              list_missing, call. = FALSE)
-    }
-
-    class(x) <- c("disk", "integer")
-    x
-  }
-}
-
-#' @rdname as.disk
-#' @export
-#' @importFrom dplyr %>%
-is.disk <- function(x) {
-  class(x) %>% identical(c("disk", "integer"))
-}
-
-#' @exportMethod print.disk
-#' @export
-#' @noRd
-print.disk <- function(x, ...) {
-  cat("Class 'disk'\n")
-  print(as.integer(x), quote = FALSE)
-}
-
-#' @importFrom pillar type_sum
-#' @export
-type_sum.disk <- function(x) {
-  "disk"
-}
-
-#' @importFrom pillar pillar_shaft
-#' @export
-pillar_shaft.disk <- function(x, ...) {
-  out <- trimws(format(x))
-  out[is.na(x)] <- pillar::style_na(NA)
-  pillar::new_pillar_shaft_simple(out, align = "right", min_width = 3)
-}

R/eucast_rules.R

@@ -1,859 +0,0 @@
-# ==================================================================== #
-# TITLE                                                                #
-# Antimicrobial Resistance (AMR) Analysis                              #
-#                                                                      #
-# SOURCE                                                               #
-# https://gitlab.com/msberends/AMR                                     #
-#                                                                      #
-# LICENCE                                                              #
-# (c) 2019 Berends MS (m.s.berends@umcg.nl), Luz CF (c.f.luz@umcg.nl)  #
-#                                                                      #
-# This R package is free software; you can freely use and distribute   #
-# it for both personal and commercial purposes under the terms of the  #
-# GNU General Public License version 2.0 (GNU GPL-2), as published by  #
-# the Free Software Foundation.                                        #
-#                                                                      #
-# This R package was created for academic research and was publicly    #
-# released in the hope that it will be useful, but it comes WITHOUT    #
-# ANY WARRANTY OR LIABILITY.                                           #
-# Visit our website for more info: https://msberends.gitlab.io/AMR.    #
-# ==================================================================== #
-
-# global variables
-EUCAST_VERSION_BREAKPOINTS <- "9.0, 2019"
-EUCAST_VERSION_EXPERT_RULES <- "3.1, 2016"
-
-#' EUCAST rules
-#' 
-#' @description
-#' Apply susceptibility rules as defined by the European Committee on Antimicrobial Susceptibility Testing (EUCAST, <http://eucast.org>), see *Source*. This includes (1) expert rules, (2) intrinsic resistance and (3) inferred resistance as defined in their breakpoint tables. 
-#' 
-#' To improve the interpretation of the antibiogram before EUCAST rules are applied, some non-EUCAST rules are applied at default, see Details.
-#' @param x data with antibiotic columns, like e.g. `AMX` and `AMC`
-#' @param info print progress
-#' @param rules a character vector that specifies which rules should be applied - one or more of `c("breakpoints", "expert", "other", "all")`
-#' @param verbose a logical to turn Verbose mode on and off (default is off). In Verbose mode, the function does not apply rules to the data, but instead returns a data set in logbook form with extensive info about which rows and columns would be effected and in which way.
-#' @param ... column name of an antibiotic, please see section *Antibiotics* below
-#' @inheritParams first_isolate
-#' @details
-#' **Note:** This function does not translate MIC values to RSI values. Use [as.rsi()] for that. \cr
-#' **Note:** When ampicillin (AMP, J01CA01) is not available but amoxicillin (AMX, J01CA04) is, the latter will be used for all rules where there is a dependency on ampicillin. These drugs are interchangeable when it comes to expression of antimicrobial resistance.
-#'
-#' Before further processing, some non-EUCAST rules are applied to improve the efficacy of the EUCAST rules. These non-EUCAST rules, that are applied to all isolates, are:
-#' - Inherit amoxicillin (AMX) from ampicillin (AMP), where amoxicillin (AMX) is unavailable;
-#' - Inherit ampicillin (AMP) from amoxicillin (AMX), where ampicillin (AMP) is unavailable;
-#' - Set amoxicillin (AMX) = R where amoxicillin/clavulanic acid (AMC) = R;
-#' - Set piperacillin (PIP) = R where piperacillin/tazobactam (TZP) = R;
-#' - Set trimethoprim (TMP) = R where trimethoprim/sulfamethoxazole (SXT) = R;
-#' - Set amoxicillin/clavulanic acid (AMC) = S where amoxicillin (AMX) = S;
-#' - Set piperacillin/tazobactam (TZP) = S where piperacillin (PIP) = S;
-#' - Set trimethoprim/sulfamethoxazole (SXT) = S where trimethoprim (TMP) = S.
-#' To *not* use these rules, please use `eucast_rules(..., rules = c("breakpoints", "expert"))`.
-#'
-#' The file containing all EUCAST rules is located here: <https://gitlab.com/msberends/AMR/blob/master/data-raw/eucast_rules.tsv>.
-#'
-#' @section Antibiotics:
-#' To define antibiotics column names, leave as it is to determine it automatically with [guess_ab_col()] or input a text (case-insensitive), or use `NULL` to skip a column (e.g. `TIC = NULL` to skip ticarcillin). Manually defined but non-existing columns will be skipped with a warning.
-#'
-#' The following antibiotics are used for the functions [eucast_rules()] and [mdro()]. These are shown below in the format '**antimicrobial ID**: name ([ATC code](https://www.whocc.no/atc/structure_and_principles/))', sorted by name:
-#'
-#'  **AMK**: amikacin ([J01GB06](https://www.whocc.no/atc_ddd_index/?code=J01GB06)),
-#'  **AMX**: amoxicillin ([J01CA04](https://www.whocc.no/atc_ddd_index/?code=J01CA04)),
-#'  **AMC**: amoxicillin/clavulanic acid ([J01CR02](https://www.whocc.no/atc_ddd_index/?code=J01CR02)),
-#'  **AMP**: ampicillin ([J01CA01](https://www.whocc.no/atc_ddd_index/?code=J01CA01)),
-#'  **SAM**: ampicillin/sulbactam ([J01CR01](https://www.whocc.no/atc_ddd_index/?code=J01CR01)),
-#'  **AZM**: azithromycin ([J01FA10](https://www.whocc.no/atc_ddd_index/?code=J01FA10)),
-#'  **AZL**: azlocillin ([J01CA09](https://www.whocc.no/atc_ddd_index/?code=J01CA09)),
-#'  **ATM**: aztreonam ([J01DF01](https://www.whocc.no/atc_ddd_index/?code=J01DF01)),
-#'  **CAP**: capreomycin ([J04AB30](https://www.whocc.no/atc_ddd_index/?code=J04AB30)),
-#'  **RID**: cefaloridine ([J01DB02](https://www.whocc.no/atc_ddd_index/?code=J01DB02)),
-#'  **CZO**: cefazolin ([J01DB04](https://www.whocc.no/atc_ddd_index/?code=J01DB04)),
-#'  **FEP**: cefepime ([J01DE01](https://www.whocc.no/atc_ddd_index/?code=J01DE01)),
-#'  **CTX**: cefotaxime ([J01DD01](https://www.whocc.no/atc_ddd_index/?code=J01DD01)),
-#'  **CTT**: cefotetan ([J01DC05](https://www.whocc.no/atc_ddd_index/?code=J01DC05)),
-#'  **FOX**: cefoxitin ([J01DC01](https://www.whocc.no/atc_ddd_index/?code=J01DC01)),
-#'  **CPT**: ceftaroline ([J01DI02](https://www.whocc.no/atc_ddd_index/?code=J01DI02)),
-#'  **CAZ**: ceftazidime ([J01DD02](https://www.whocc.no/atc_ddd_index/?code=J01DD02)),
-#'  **CRO**: ceftriaxone ([J01DD04](https://www.whocc.no/atc_ddd_index/?code=J01DD04)),
-#'  **CXM**: cefuroxime ([J01DC02](https://www.whocc.no/atc_ddd_index/?code=J01DC02)),
-#'  **CED**: cephradine ([J01DB09](https://www.whocc.no/atc_ddd_index/?code=J01DB09)),
-#'  **CHL**: chloramphenicol ([J01BA01](https://www.whocc.no/atc_ddd_index/?code=J01BA01)),
-#'  **CIP**: ciprofloxacin ([J01MA02](https://www.whocc.no/atc_ddd_index/?code=J01MA02)),
-#'  **CLR**: clarithromycin ([J01FA09](https://www.whocc.no/atc_ddd_index/?code=J01FA09)),
-#'  **CLI**: clindamycin ([J01FF01](https://www.whocc.no/atc_ddd_index/?code=J01FF01)),
-#'  **COL**: colistin ([J01XB01](https://www.whocc.no/atc_ddd_index/?code=J01XB01)),
-#'  **DAP**: daptomycin ([J01XX09](https://www.whocc.no/atc_ddd_index/?code=J01XX09)),
-#'  **DOR**: doripenem ([J01DH04](https://www.whocc.no/atc_ddd_index/?code=J01DH04)),
-#'  **DOX**: doxycycline ([J01AA02](https://www.whocc.no/atc_ddd_index/?code=J01AA02)),
-#'  **ETP**: ertapenem ([J01DH03](https://www.whocc.no/atc_ddd_index/?code=J01DH03)),
-#'  **ERY**: erythromycin ([J01FA01](https://www.whocc.no/atc_ddd_index/?code=J01FA01)),
-#'  **ETH**: ethambutol ([J04AK02](https://www.whocc.no/atc_ddd_index/?code=J04AK02)),
-#'  **FLC**: flucloxacillin ([J01CF05](https://www.whocc.no/atc_ddd_index/?code=J01CF05)),
-#'  **FOS**: fosfomycin ([J01XX01](https://www.whocc.no/atc_ddd_index/?code=J01XX01)),
-#'  **FUS**: fusidic acid ([J01XC01](https://www.whocc.no/atc_ddd_index/?code=J01XC01)),
-#'  **GAT**: gatifloxacin ([J01MA16](https://www.whocc.no/atc_ddd_index/?code=J01MA16)),
-#'  **GEN**: gentamicin ([J01GB03](https://www.whocc.no/atc_ddd_index/?code=J01GB03)),
-#'  **GEH**: gentamicin-high (no ATC code),
-#'  **IPM**: imipenem ([J01DH51](https://www.whocc.no/atc_ddd_index/?code=J01DH51)),
-#'  **INH**: isoniazid ([J04AC01](https://www.whocc.no/atc_ddd_index/?code=J04AC01)),
-#'  **KAN**: kanamycin ([J01GB04](https://www.whocc.no/atc_ddd_index/?code=J01GB04)),
-#'  **LVX**: levofloxacin ([J01MA12](https://www.whocc.no/atc_ddd_index/?code=J01MA12)),
-#'  **LIN**: lincomycin ([J01FF02](https://www.whocc.no/atc_ddd_index/?code=J01FF02)),
-#'  **LNZ**: linezolid ([J01XX08](https://www.whocc.no/atc_ddd_index/?code=J01XX08)),
-#'  **MEM**: meropenem ([J01DH02](https://www.whocc.no/atc_ddd_index/?code=J01DH02)),
-#'  **MTR**: metronidazole ([J01XD01](https://www.whocc.no/atc_ddd_index/?code=J01XD01)),
-#'  **MEZ**: mezlocillin ([J01CA10](https://www.whocc.no/atc_ddd_index/?code=J01CA10)),
-#'  **MNO**: minocycline ([J01AA08](https://www.whocc.no/atc_ddd_index/?code=J01AA08)),
-#'  **MFX**: moxifloxacin ([J01MA14](https://www.whocc.no/atc_ddd_index/?code=J01MA14)),
-#'  **NAL**: nalidixic acid ([J01MB02](https://www.whocc.no/atc_ddd_index/?code=J01MB02)),
-#'  **NEO**: neomycin ([J01GB05](https://www.whocc.no/atc_ddd_index/?code=J01GB05)),
-#'  **NET**: netilmicin ([J01GB07](https://www.whocc.no/atc_ddd_index/?code=J01GB07)),
-#'  **NIT**: nitrofurantoin ([J01XE01](https://www.whocc.no/atc_ddd_index/?code=J01XE01)),
-#'  **NOR**: norfloxacin ([J01MA06](https://www.whocc.no/atc_ddd_index/?code=J01MA06)),
-#'  **NOV**: novobiocin ([QJ01XX95](https://www.whocc.no/atc_ddd_index/?code=QJ01XX95)),
-#'  **OFX**: ofloxacin ([J01MA01](https://www.whocc.no/atc_ddd_index/?code=J01MA01)),
-#'  **OXA**: oxacillin ([J01CF04](https://www.whocc.no/atc_ddd_index/?code=J01CF04)),
-#'  **PEN**: penicillin G ([J01CE01](https://www.whocc.no/atc_ddd_index/?code=J01CE01)),
-#'  **PIP**: piperacillin ([J01CA12](https://www.whocc.no/atc_ddd_index/?code=J01CA12)),
-#'  **TZP**: piperacillin/tazobactam ([J01CR05](https://www.whocc.no/atc_ddd_index/?code=J01CR05)),
-#'  **PLB**: polymyxin B ([J01XB02](https://www.whocc.no/atc_ddd_index/?code=J01XB02)),
-#'  **PRI**: pristinamycin ([J01FG01](https://www.whocc.no/atc_ddd_index/?code=J01FG01)),
-#'  **PZA**: pyrazinamide ([J04AK01](https://www.whocc.no/atc_ddd_index/?code=J04AK01)),
-#'  **QDA**: quinupristin/dalfopristin ([J01FG02](https://www.whocc.no/atc_ddd_index/?code=J01FG02)),
-#'  **RIB**: rifabutin ([J04AB04](https://www.whocc.no/atc_ddd_index/?code=J04AB04)),
-#'  **RIF**: rifampicin ([J04AB02](https://www.whocc.no/atc_ddd_index/?code=J04AB02)),
-#'  **RFP**: rifapentine ([J04AB05](https://www.whocc.no/atc_ddd_index/?code=J04AB05)),
-#'  **RXT**: roxithromycin ([J01FA06](https://www.whocc.no/atc_ddd_index/?code=J01FA06)),
-#'  **SIS**: sisomicin ([J01GB08](https://www.whocc.no/atc_ddd_index/?code=J01GB08)),
-#'  **STH**: streptomycin-high (no ATC code),
-#'  **TEC**: teicoplanin ([J01XA02](https://www.whocc.no/atc_ddd_index/?code=J01XA02)),
-#'  **TLV**: telavancin ([J01XA03](https://www.whocc.no/atc_ddd_index/?code=J01XA03)),
-#'  **TCY**: tetracycline ([J01AA07](https://www.whocc.no/atc_ddd_index/?code=J01AA07)),
-#'  **TIC**: ticarcillin ([J01CA13](https://www.whocc.no/atc_ddd_index/?code=J01CA13)),
-#'  **TCC**: ticarcillin/clavulanic acid ([J01CR03](https://www.whocc.no/atc_ddd_index/?code=J01CR03)),
-#'  **TGC**: tigecycline ([J01AA12](https://www.whocc.no/atc_ddd_index/?code=J01AA12)),
-#'  **TOB**: tobramycin ([J01GB01](https://www.whocc.no/atc_ddd_index/?code=J01GB01)),
-#'  **TMP**: trimethoprim ([J01EA01](https://www.whocc.no/atc_ddd_index/?code=J01EA01)),
-#'  **SXT**: trimethoprim/sulfamethoxazole ([J01EE01](https://www.whocc.no/atc_ddd_index/?code=J01EE01)),
-#'  **VAN**: vancomycin ([J01XA01](https://www.whocc.no/atc_ddd_index/?code=J01XA01)).
-#' @aliases EUCAST
-#' @rdname eucast_rules
-#' @export
-#' @importFrom dplyr %>% select pull mutate_at vars group_by summarise n
-#' @importFrom crayon bold bgGreen bgYellow bgRed black green blue italic strip_style white red make_style
-#' @importFrom utils menu
-#' @return The input of `x`, possibly with edited values of antibiotics. Or, if `verbose = TRUE`, a [`data.frame`] with all original and new values of the affected bug-drug combinations.
-#' @source
-#' - EUCAST Expert Rules. Version 2.0, 2012. \cr
-#'   Leclercq et al. **EUCAST expert rules in antimicrobial susceptibility testing.** *Clin Microbiol Infect.* 2013;19(2):141-60. \cr
-#'   <https://doi.org/10.1111/j.1469-0691.2011.03703.x>
-#' - EUCAST Expert Rules, Intrinsic Resistance and Exceptional Phenotypes Tables. Version 3.1, 2016.  \cr
-#'   <http://www.eucast.org/fileadmin/src/media/PDFs/EUCAST_files/Expert_Rules/Expert_rules_intrinsic_exceptional_V3.1.pdf>
-#' - EUCAST Breakpoint tables for interpretation of MICs and zone diameters. Version 9.0, 2019. \cr
-#'   <http://www.eucast.org/fileadmin/src/media/PDFs/EUCAST_files/Breakpoint_tables/v_9.0_Breakpoint_Tables.xlsx>
-#' @inheritSection AMR Read more on our website!
-#' @examples
-#' \donttest{
-#' a <- data.frame(mo = c("Staphylococcus aureus",
-#'                        "Enterococcus faecalis",
-#'                        "Escherichia coli",
-#'                        "Klebsiella pneumoniae",
-#'                        "Pseudomonas aeruginosa"),
-#'                 VAN = "-",       # Vancomycin
-#'                 AMX = "-",       # Amoxicillin
-#'                 COL = "-",       # Colistin
-#'                 CAZ = "-",       # Ceftazidime
-#'                 CXM = "-",       # Cefuroxime
-#'                 PEN = "S",       # Penicillin G
-#'                 FOX = "S",       # Cefoxitin
-#'                 stringsAsFactors = FALSE)
-#'
-#' a
-#' #                       mo  VAN  AMX  COL  CAZ  CXM  PEN  FOX
-#' # 1  Staphylococcus aureus    -    -    -    -    -    S    S
-#' # 2  Enterococcus faecalis    -    -    -    -    -    S    S
-#' # 3       Escherichia coli    -    -    -    -    -    S    S
-#' # 4  Klebsiella pneumoniae    -    -    -    -    -    S    S
-#' # 5 Pseudomonas aeruginosa    -    -    -    -    -    S    S
-#'
-#'
-#' # apply EUCAST rules: 18 results are forced as R or S
-#' b <- eucast_rules(a)
-#'
-#' b
-#' #                       mo  VAN  AMX  COL  CAZ  CXM  PEN  FOX
-#' # 1  Staphylococcus aureus    -    S    R    R    S    S    S
-#' # 2  Enterococcus faecalis    -    -    R    R    R    S    R
-#' # 3       Escherichia coli    R    -    -    -    -    R    S
-#' # 4  Klebsiella pneumoniae    R    R    -    -    -    R    S
-#' # 5 Pseudomonas aeruginosa    R    R    -    -    R    R    R
-#'
-#'
-#' # do not apply EUCAST rules, but rather get a data.frame
-#' # with 18 rows, containing all details about the transformations:
-#' c <- eucast_rules(a, verbose = TRUE)
-#' }
-eucast_rules <- function(x,
-                         col_mo = NULL,
-                         info = TRUE,
-                         rules = c("breakpoints", "expert", "other", "all"),
-                         verbose = FALSE,
-                         ...) {
-  
-  if (verbose == TRUE & interactive()) {
-    txt <- paste0("WARNING: In Verbose mode, the eucast_rules() function does not apply rules to the data, but instead returns a data set in logbook form with extensive info about which rows and columns would be effected and in which way.",
-                  "\n\nThis may overwrite your existing data if you use e.g.:",
-                  "\ndata <- eucast_rules(data, verbose = TRUE)\n\nDo you want to continue?")
-    if ("rstudioapi" %in% rownames(utils::installed.packages())) {
-      q_continue <- rstudioapi::showQuestion("Using verbose = TRUE with eucast_rules()", txt)
-    } else {
-      q_continue <- menu(choices = c("OK", "Cancel"), graphics = TRUE, title = txt)
-    }
-    if (q_continue %in% c(FALSE, 2)) {
-      message("Cancelled, returning original data")
-      return(x)
-    }
-  }
-  
-  if (!is.data.frame(x)) {
-    stop("`x` must be a data frame.", call. = FALSE)
-  }
-  
-  # try to find columns based on type
-  # -- mo
-  if (is.null(col_mo)) {
-    col_mo <- search_type_in_df(x = x, type = "mo")
-  }
-  if (is.null(col_mo)) {
-    stop("`col_mo` must be set.", call. = FALSE)
-  }
-  
-  if (!all(rules %in% c("breakpoints", "expert", "other", "all"))) {
-    stop("`rules` must be one or more of:  'breakpoints', 'expert', 'other', 'all'.")
-  }
-  
-  if (is.null(col_mo)) {
-    stop("`col_mo` must be set")
-  }
-  
-  decimal.mark <- getOption("OutDec")
-  big.mark <- ifelse(decimal.mark != ",", ",", ".")
-  formatnr <- function(x) {
-    trimws(format(x, big.mark = big.mark, decimal.mark = decimal.mark))
-  }
-  
-  grey <- make_style("grey")
-  
-  warned <- FALSE
-  
-  txt_error <- function() {
-    if (info == TRUE) cat("", bgRed(white(" ERROR ")), "\n\n") 
-  }
-  txt_warning <- function() {
-    if (warned == FALSE) {
-      if (info == TRUE) cat("", bgYellow(black(" WARNING ")))
-    }
-    warned <<- TRUE 
-  }
-  txt_ok <- function(no_added, no_changed) {
-    if (warned == FALSE) {
-      if (no_added + no_changed == 0) {
-        cat(pillar::style_subtle(" (no changes)\n"))
-      } else {
-        # opening
-        cat(grey(" ("))
-        # additions
-        if (no_added > 0) {
-          if (no_added == 1) {
-            cat(green("1 value added"))
-          } else {
-            cat(green(formatnr(no_added), "values added"))
-          }
-        }
-        # separator
-        if (no_added > 0 & no_changed > 0) {
-          cat(grey(", "))
-        }
-        # changes
-        if (no_changed > 0) {
-          if (no_changed == 1) {
-            cat(blue("1 value changed"))
-          } else {
-            cat(blue(formatnr(no_changed), "values changed"))
-          }
-        } 
-        # closing
-        cat(grey(")\n"))
-      }
-      warned <<- FALSE
-    }
-  }
-  
-  cols_ab <- get_column_abx(x = x,
-                            soft_dependencies = c("AMC",
-                                                  "AMK",
-                                                  "AMX",
-                                                  "AMP",
-                                                  "AZM",
-                                                  "AZL",
-                                                  "ATM",
-                                                  "RID",
-                                                  "FEP",
-                                                  "CTX",
-                                                  "FOX",
-                                                  "CED",
-                                                  "CAZ",
-                                                  "CRO",
-                                                  "CXM",
-                                                  "CHL",
-                                                  "CIP",
-                                                  "CLR",
-                                                  "CLI",
-                                                  "FLC",
-                                                  "COL",
-                                                  "CZO",
-                                                  "DAP",
-                                                  "DOX",
-                                                  "ETP",
-                                                  "ERY",
-                                                  "FOS",
-                                                  "FUS",
-                                                  "GEN",
-                                                  "IPM",
-                                                  "KAN",
-                                                  "LVX",
-                                                  "LIN",
-                                                  "LNZ",
-                                                  "MEM",
-                                                  "MEZ",
-                                                  "MNO",
-                                                  "MFX",
-                                                  "NAL",
-                                                  "NEO",
-                                                  "NET",
-                                                  "NIT",
-                                                  "NOR",
-                                                  "NOV",
-                                                  "OFX",
-                                                  "OXA",
-                                                  "PEN",
-                                                  "PIP",
-                                                  "TZP",
-                                                  "PLB",
-                                                  "PRI",
-                                                  "QDA",
-                                                  "RIF",
-                                                  "RXT",
-                                                  "SIS",
-                                                  "TEC",
-                                                  "TCY",
-                                                  "TIC",
-                                                  "TGC",
-                                                  "TOB",
-                                                  "TMP",
-                                                  "SXT",
-                                                  "VAN"),
-                            hard_dependencies = NULL,
-                            verbose = verbose,
-                            ...)
-  
-  AMC <- cols_ab["AMC"]
-  AMK <- cols_ab["AMK"]
-  AMP <- cols_ab["AMP"]
-  AMX <- cols_ab["AMX"]
-  ATM <- cols_ab["ATM"]
-  AZL <- cols_ab["AZL"]
-  AZM <- cols_ab["AZM"]
-  CAZ <- cols_ab["CAZ"]
-  CED <- cols_ab["CED"]
-  CHL <- cols_ab["CHL"]
-  CIP <- cols_ab["CIP"]
-  CLI <- cols_ab["CLI"]
-  CLR <- cols_ab["CLR"]
-  COL <- cols_ab["COL"]
-  CRO <- cols_ab["CRO"]
-  CTX <- cols_ab["CTX"]
-  CXM <- cols_ab["CXM"]
-  CZO <- cols_ab["CZO"]
-  DAP <- cols_ab["DAP"]
-  DOX <- cols_ab["DOX"]
-  ERY <- cols_ab["ERY"]
-  ETP <- cols_ab["ETP"]
-  FEP <- cols_ab["FEP"]
-  FLC <- cols_ab["FLC"]
-  FOS <- cols_ab["FOS"]
-  FOX <- cols_ab["FOX"]
-  FUS <- cols_ab["FUS"]
-  GEN <- cols_ab["GEN"]
-  IPM <- cols_ab["IPM"]
-  KAN <- cols_ab["KAN"]
-  LIN <- cols_ab["LIN"]
-  LNZ <- cols_ab["LNZ"]
-  LVX <- cols_ab["LVX"]
-  MEM <- cols_ab["MEM"]
-  MEZ <- cols_ab["MEZ"]
-  MFX <- cols_ab["MFX"]
-  MNO <- cols_ab["MNO"]
-  NAL <- cols_ab["NAL"]
-  NEO <- cols_ab["NEO"]
-  NET <- cols_ab["NET"]
-  NIT <- cols_ab["NIT"]
-  NOR <- cols_ab["NOR"]
-  NOV <- cols_ab["NOV"]
-  OFX <- cols_ab["OFX"]
-  OXA <- cols_ab["OXA"]
-  PEN <- cols_ab["PEN"]
-  PIP <- cols_ab["PIP"]
-  PLB <- cols_ab["PLB"]
-  PRI <- cols_ab["PRI"]
-  QDA <- cols_ab["QDA"]
-  RID <- cols_ab["RID"]
-  RIF <- cols_ab["RIF"]
-  RXT <- cols_ab["RXT"]
-  SIS <- cols_ab["SIS"]
-  SXT <- cols_ab["SXT"]
-  TCY <- cols_ab["TCY"]
-  TEC <- cols_ab["TEC"]
-  TGC <- cols_ab["TGC"]
-  TIC <- cols_ab["TIC"]
-  TMP <- cols_ab["TMP"]
-  TOB <- cols_ab["TOB"]
-  TZP <- cols_ab["TZP"]
-  VAN <- cols_ab["VAN"]
-  
-  ab_missing <- function(ab) {
-    all(ab %in% c(NULL, NA))
-  }
-  
-  verbose_info <- data.frame(row = integer(0),
-                             col = character(0),
-                             mo_fullname = character(0),
-                             old = as.rsi(character(0)),
-                             new = as.rsi(character(0)),
-                             rule = character(0),
-                             rule_group = character(0),
-                             rule_name = character(0),
-                             stringsAsFactors = FALSE)
-  
-  # helper function for editing the table
-  edit_rsi <- function(to, rule, rows, cols) {
-    cols <- unique(cols[!is.na(cols) & !is.null(cols)])
-    if (length(rows) > 0 & length(cols) > 0) {
-      before_df <- x_original
-      
-      tryCatch(
-        # insert into original table
-        x_original[rows, cols] <<- to,
-        warning = function(w) {
-          if (w$message %like% "invalid factor level") {
-            x_original <<- x_original %>% mutate_at(vars(cols), ~factor(x = as.character(.), levels = c(to, levels(.))))
-            x <<- x %>% mutate_at(vars(cols), ~factor(x = as.character(.), levels = c(to, levels(.))))
-            x_original[rows, cols] <<- to
-            warning('Value "', to, '" added to the factor levels of column(s) `', paste(cols, collapse = "`, `"), "` because this value was not an existing factor level.\nA better way is to use as.rsi() on beforehand on antimicrobial columns to guarantee the right structure.", call. = FALSE)
-            txt_warning()
-            warned <<- FALSE
-          } else {
-            warning(w$message, call. = FALSE)
-            txt_warning()
-            cat("\n") # txt_warning() does not append a "\n" on itself
-          }
-        },
-        error = function(e) {
-          txt_error()
-          stop(paste0("In row(s) ", paste(rows[1:min(length(rows), 10)], collapse = ","), 
-                      ifelse(length(rows) > 10, "...", ""),
-                      " while writing value '", to, 
-                      "' to column(s) `", paste(cols, collapse = "`, `"), 
-                      "`:\n", e$message),
-               call. = FALSE)
-        }
-      )
-      
-      tryCatch(
-        x[rows, cols] <<- x_original[rows, cols],
-        error = function(e) {
-          stop(paste0("In row(s) ", paste(rows[1:min(length(rows), 10)], collapse = ","),
-                      "... while writing value '", to, 
-                      "' to column(s) `", paste(cols, collapse = "`, `"), 
-                      "`:\n", e$message), call. = FALSE)
-        }
-      )
-      
-      # before_df might not be a data.frame, but a tibble or data.table instead
-      old <- as.data.frame(before_df, stringsAsFactors = FALSE)[rows, ]
-      track_changes <- list(added = 0,
-                            changed = 0)
-      for (i in seq_len(length(cols))) {
-        verbose_new <- data.frame(row = rows,
-                                  col = cols[i],
-                                  mo_fullname = x[rows, "fullname"],
-                                  old = as.rsi(as.character(old[, cols[i]]), warn = FALSE),
-                                  new = as.rsi(as.character(x[rows, cols[i]])),
-                                  rule = strip_style(rule[1]),
-                                  rule_group = strip_style(rule[2]),
-                                  rule_name = strip_style(rule[3]),
-                                  stringsAsFactors = FALSE)
-        colnames(verbose_new) <- c("row", "col", "mo_fullname", "old", "new", "rule", "rule_group", "rule_name")
-        verbose_new <- verbose_new %>% filter(old != new | is.na(old))
-        # save changes to data set 'verbose_info'
-        verbose_info <<- rbind(verbose_info, verbose_new)
-        # count adds and changes
-        track_changes$added <- track_changes$added + verbose_new %>% filter(is.na(old)) %>% nrow()
-        track_changes$changed <- track_changes$changed + verbose_new %>% filter(!is.na(old)) %>% nrow()
-      }
-      # after the applied changes: return list with counts of added and changed
-      return(track_changes)
-    }
-    # no changes were applied: return number of (new) changes: none.
-    return(list(added = 0,
-                changed = 0))
-  }
-  
-  # save original table
-  x_original <- x
-  
-  # join to microorganisms data set
-  suppressWarnings(
-    x <- x %>%
-      mutate_at(vars(col_mo), as.mo) %>%
-      left_join_microorganisms(by = col_mo, suffix = c("_oldcols", "")) %>%
-      mutate(gramstain = mo_gramstain(pull(., col_mo), language = "en"),
-             genus_species = paste(genus, species)) %>%
-      as.data.frame(stringsAsFactors = FALSE)
-  )
-  
-  if (ab_missing(AMP) & !ab_missing(AMX)) {
-    # ampicillin column is missing, but amoxicillin is available
-    message(blue(paste0("NOTE: Using column `", bold(AMX), "` as input for ampicillin (J01CA01) since many EUCAST rules depend on it.")))
-    AMP <- AMX
-  }
-  
-  # nolint start
-  # antibiotic classes
-  aminoglycosides <- c(TOB, GEN, KAN, NEO, NET, SIS)
-  tetracyclines <- c(DOX, MNO, TCY) # since EUCAST v3.1 tigecycline (TGC) is set apart
-  polymyxins <- c(PLB, COL)
-  macrolides <- c(ERY, AZM, RXT, CLR) # since EUCAST v3.1 clinda is set apart
-  glycopeptides <- c(VAN, TEC)
-  streptogramins <- c(QDA, PRI) # should officially also be quinupristin/dalfopristin
-  aminopenicillins <- c(AMP, AMX)
-  cephalosporins <- c(FEP, CTX, FOX, CED, CAZ, CRO, CXM, CZO)
-  cephalosporins_except_CAZ <- cephalosporins[cephalosporins != ifelse(is.null(CAZ), "", CAZ)]
-  carbapenems <- c(ETP, IPM, MEM)
-  ureidopenicillins <- c(PIP, TZP, AZL, MEZ)
-  all_betalactams <- c(aminopenicillins, cephalosporins, carbapenems, ureidopenicillins, AMC, OXA, FLC, PEN)
-  fluoroquinolones <- c(OFX, CIP, NOR, LVX, MFX)
-  # nolint end
-  
-  # Help function to get available antibiotic column names ------------------
-  get_antibiotic_columns <- function(x, df) {
-    x <- trimws(unlist(strsplit(x, ",", fixed = TRUE)))
-    y <- character(0)
-    for (i in seq_len(length(x))) {
-      if (is.function(get(x[i]))) {
-        stop("Column ", x[i], " is also a function. Please create an issue on github.com/msberends/AMR/issues.")
-      }
-      y <- c(y, tryCatch(get(x[i]), error = function(e) ""))
-    }
-    y[y != "" & y %in% colnames(df)]
-  }
-  get_antibiotic_names <- function(x) {
-    x <- x %>%
-      strsplit(",") %>%
-      unlist() %>%
-      trimws() %>%
-      sapply(function(x) if (x %in% AMR::antibiotics$ab) ab_name(x, language = NULL, tolower = TRUE) else x) %>%
-      sort() %>%
-      paste(collapse = ", ")
-    x <- gsub("_", " ", x, fixed = TRUE)
-    x <- gsub("except CAZ", paste("except", ab_name("CAZ", language = NULL, tolower = TRUE)), x, fixed = TRUE)
-    x
-  }
-  format_antibiotic_names <- function(ab_names, ab_results) {
-    ab_names <- trimws(unlist(strsplit(ab_names, ",")))
-    ab_results <- trimws(unlist(strsplit(ab_results, ",")))
-    if (length(ab_results) == 1) {
-      if (length(ab_names) == 1) {
-        # like FOX S
-        x <- paste(ab_names, "is")
-      } else if (length(ab_names) == 2) {
-        # like PEN,FOX S
-        x <- paste(paste0(ab_names, collapse = " and "), "are both")
-      } else {
-        # like PEN,FOX,GEN S (although dependency on > 2 ABx does not exist at the moment)
-        x <- paste(paste0(ab_names, collapse = " and "), "are all")
-      }
-      return(paste0(x, " '", ab_results, "'"))
-    } else {
-      if (length(ab_names) == 2) {
-        # like PEN,FOX S,R
-        paste0(ab_names[1], " is '", ab_results[1], "' and ", 
-               ab_names[2], " is '", ab_results[2], "'")
-      } else {
-        # like PEN,FOX,GEN S,R,R (although dependency on > 2 ABx does not exist at the moment)
-        paste0(ab_names[1], " is '", ab_results[1], "' and ", 
-               ab_names[2], " is '", ab_results[2], "' and ", 
-               ab_names[3], " is '", ab_results[3], "'")
-      }
-    }
-  }
-  
-  eucast_notification_shown <- FALSE
-  eucast_rules_df <- eucast_rules_file # internal data file
-  no_added <- 0
-  no_changed <- 0
-  for (i in seq_len(nrow(eucast_rules_df))) {
-    
-    rule_previous <- eucast_rules_df[max(1, i - 1), "reference.rule"]
-    rule_current <- eucast_rules_df[i, "reference.rule"]
-    rule_next <- eucast_rules_df[min(nrow(eucast_rules_df), i + 1), "reference.rule"]
-    rule_group_previous <- eucast_rules_df[max(1, i - 1), "reference.rule_group"]
-    rule_group_current <- eucast_rules_df[i, "reference.rule_group"]
-    if (is.na(eucast_rules_df[i, 4])) {
-      rule_text <- paste0("always report as '", eucast_rules_df[i, 7], "': ", get_antibiotic_names(eucast_rules_df[i, 6]))
-    } else {
-      rule_text <- paste0("report as '", eucast_rules_df[i, 7], "' when ",
-                          format_antibiotic_names(ab_names = get_antibiotic_names(eucast_rules_df[i, 4]),
-                                                  ab_results = eucast_rules_df[i, 5]), ": ",
-                          get_antibiotic_names(eucast_rules_df[i, 6]))
-    }
-    if (i == 1) {
-      rule_previous <- ""
-      rule_group_previous <- ""
-    }
-    if (i == nrow(eucast_rules_df)) {
-      rule_next <- ""
-    }
-    
-    # don't apply rules if user doesn't want to apply them
-    if (rule_group_current %like% "breakpoint" & !any(c("all", "breakpoints") %in% rules)) {
-      next
-    }
-    if (rule_group_current %like% "expert" & !any(c("all", "expert") %in% rules)) {
-      next
-    }
-    if (rule_group_current %like% "other" & !any(c("all", "other") %in% rules)) {
-      next
-    }
-    
-    if (info == TRUE & !rule_group_current %like% "other" & eucast_notification_shown == FALSE) {
-      cat(paste0(
-        "\n----\nRules by the ", bold("European Committee on Antimicrobial Susceptibility Testing (EUCAST)"),
-        "\n", blue("http://eucast.org/"), "\n"))
-      eucast_notification_shown <- TRUE
-    }
-    
-    
-    if (info == TRUE) {
-      # Print rule (group) ------------------------------------------------------
-      if (rule_group_current != rule_group_previous) {
-        # is new rule group, one of Breakpoints, Expert Rules and Other
-        cat(bold(
-          case_when(
-            rule_group_current %like% "breakpoint" ~
-              paste0("\nEUCAST Clinical Breakpoints (v", EUCAST_VERSION_BREAKPOINTS, ")\n"),
-            rule_group_current %like% "expert" ~
-              paste0("\nEUCAST Expert Rules, Intrinsic Resistance and Exceptional Phenotypes (v", EUCAST_VERSION_EXPERT_RULES, ")\n"),
-            TRUE ~
-              "\nOther rules by this AMR package\n"
-          )
-        ))
-      }
-      # Print rule  -------------------------------------------------------------
-      if (rule_current != rule_previous) {
-        # is new rule within group, print its name
-        if (rule_current %in% c(AMR::microorganisms$family,
-                                AMR::microorganisms$fullname)) {
-          cat(italic(rule_current))
-        } else {
-          cat(rule_current)
-        }
-        warned <- FALSE
-      }
-    }
-    
-    # Get rule from file ------------------------------------------------------
-    col_mo_property <- eucast_rules_df[i, 1]
-    like_is_one_of <- eucast_rules_df[i, 2]
-    
-    # be sure to comprise all coagulase-negative/-positive Staphylococci when they are mentioned
-    if (eucast_rules_df[i, 3] %like% "coagulase-") {
-      suppressWarnings(
-        all_staph <- AMR::microorganisms %>%
-          filter(genus == "Staphylococcus") %>%
-          mutate(CNS_CPS = mo_name(mo, Becker = "all"))
-      )
-      if (eucast_rules_df[i, 3] %like% "coagulase-") {
-        eucast_rules_df[i, 3] <- paste0("^(",
-                                        paste0(all_staph %>%
-                                                 filter(CNS_CPS %like% "coagulase-negative") %>%
-                                                 pull(fullname),
-                                               collapse = "|"),
-                                        ")$")
-      } else {
-        eucast_rules_df[i, 3] <- paste0("^(",
-                                        paste0(all_staph %>%
-                                                 filter(CNS_CPS %like% "coagulase-positive") %>%
-                                                 pull(fullname),
-                                               collapse = "|"),
-                                        ")$")
-      }
-      like_is_one_of <- "like"
-    }
-    
-    if (like_is_one_of == "is") {
-      # so 'Enterococcus' will turn into '^Enterococcus$'
-      mo_value <- paste0("^", eucast_rules_df[i, 3], "$")
-    } else if (like_is_one_of == "one_of") {
-      # so 'Clostridium, Actinomyces, ...' will turn into '^(Clostridium|Actinomyces|...)$'
-      mo_value <- paste0("^(",
-                         paste(trimws(unlist(strsplit(eucast_rules_df[i, 3], ",", fixed = TRUE))),
-                               collapse = "|"),
-                         ")$")
-    } else if (like_is_one_of == "like") {
-      mo_value <- eucast_rules_df[i, 3]
-    } else {
-      stop("invalid value for column 'like.is.one_of'", call. = FALSE)
-    }
-    
-    source_antibiotics <- eucast_rules_df[i, 4]
-    source_value <- trimws(unlist(strsplit(eucast_rules_df[i, 5], ",", fixed = TRUE)))
-    target_antibiotics <- eucast_rules_df[i, 6]
-    target_value <- eucast_rules_df[i, 7]
-    
-    if (is.na(source_antibiotics)) {
-      rows <- tryCatch(which(x[, col_mo_property] %like% mo_value),
-                       error = function(e) integer(0))
-    } else {
-      source_antibiotics <- get_antibiotic_columns(source_antibiotics, x)
-      if (length(source_value) == 1 & length(source_antibiotics) > 1) {
-        source_value <- rep(source_value, length(source_antibiotics))
-      }
-      if (length(source_antibiotics) == 0) {
-        rows <- integer(0)
-      } else if (length(source_antibiotics) == 1) {
-        rows <-  tryCatch(which(x[, col_mo_property] %like% mo_value
-                                & x[, source_antibiotics[1L]] == source_value[1L]),
-                          error = function(e) integer(0))
-      } else if (length(source_antibiotics) == 2) {
-        rows <-  tryCatch(which(x[, col_mo_property] %like% mo_value
-                                & x[, source_antibiotics[1L]] == source_value[1L]
-                                & x[, source_antibiotics[2L]] == source_value[2L]),
-                          error = function(e) integer(0))
-      } else if (length(source_antibiotics) == 3) {
-        rows <-  tryCatch(which(x[, col_mo_property] %like% mo_value
-                                & x[, source_antibiotics[1L]] == source_value[1L]
-                                & x[, source_antibiotics[2L]] == source_value[2L]
-                                & x[, source_antibiotics[3L]] == source_value[3L]),
-                          error = function(e) integer(0))
-      } else {
-        stop("only 3 antibiotics supported for source_antibiotics ", call. = FALSE)
-      }
-    }
-    
-    cols <- get_antibiotic_columns(target_antibiotics, x)
-    
-    # Apply rule on data ------------------------------------------------------
-    # this will return the unique number of changes
-    run_changes <- edit_rsi(to = target_value,
-                            rule = c(rule_text, rule_group_current, rule_current),
-                            rows = rows,
-                            cols = cols)
-    no_added <- no_added + run_changes$added
-    no_changed <- no_changed + run_changes$changed
-    
-    # Print number of new changes ---------------------------------------------
-    if (info == TRUE & rule_next != rule_current) {
-      # print only on last one of rules in this group
-      txt_ok(no_added = no_added, no_changed = no_changed)
-      # and reset counters
-      no_added <- 0
-      no_changed <- 0
-    }
-  }
-  
-  # Print overview ----------------------------------------------------------
-  if (info == TRUE) {
-    if (verbose == TRUE) {
-      wouldve <- "would have "
-    } else {
-      wouldve <- ""
-    }
-    
-    verbose_info <- verbose_info %>%
-      arrange(row, rule_group, rule_name, col)
-    
-    cat(paste0("\n", grey(strrep("-", options()$width - 1)), "\n"))
-    cat(bold(paste("EUCAST rules", paste0(wouldve, "affected"),
-                   formatnr(n_distinct(verbose_info$row)),
-                   "out of", formatnr(nrow(x_original)),
-                   "rows, making a total of", formatnr(nrow(verbose_info)), "edits\n")))
-    
-    n_added <- verbose_info %>% filter(is.na(old)) %>% nrow()
-    n_changed <- verbose_info %>% filter(!is.na(old)) %>% nrow()
-    
-    # print added values ----
-    if (n_added == 0) {
-      colour <- cat # is function
-    } else {
-      colour <- green # is function
-    }
-    cat(colour(paste0("=> ", wouldve, "added ",
-                      bold(formatnr(verbose_info %>%
-                                      filter(is.na(old)) %>%
-                                      nrow()), "test results"),
-                      "\n")))
-    if (n_added > 0) {
-      verbose_info %>%
-        filter(is.na(old)) %>%
-        group_by(new) %>%
-        summarise(n = n()) %>%
-        mutate(plural = ifelse(n > 1, "s", ""),
-               txt = paste0(formatnr(n), " test result", plural, " added as ", new)) %>%
-        pull(txt) %>%
-        paste("   -", ., collapse = "\n") %>%
-        cat()
-    }
-    
-    # print changed values ----
-    if (n_changed == 0) {
-      colour <- cat # is function
-    } else {
-      colour <- blue # is function
-    }
-    if (n_added + n_changed > 0) {
-      cat("\n")
-    }
-    cat(colour(paste0("=> ", wouldve, "changed ",
-                      bold(formatnr(verbose_info %>%
-                                      filter(!is.na(old)) %>%
-                                      nrow()), "test results"),
-                      "\n")))
-    if (n_changed > 0) {
-      verbose_info %>%
-        filter(!is.na(old)) %>%
-        group_by(old, new) %>%
-        summarise(n = n()) %>%
-        mutate(plural = ifelse(n > 1, "s", ""),
-               txt = paste0(formatnr(n), " test result", plural, " changed from ", old, " to ", new)) %>%
-        pull(txt) %>%
-        paste("   -", ., collapse = "\n") %>%
-        cat()
-      cat("\n")
-    }
-    cat(paste0(grey(strrep("-", options()$width - 1)), "\n"))
-    
-    if (verbose == FALSE & nrow(verbose_info) > 0) {
-      cat(paste("\nUse", bold("eucast_rules(..., verbose = TRUE)"), "(on your original data) to get a data.frame with all specified edits instead.\n\n"))
-    } else if (verbose == TRUE) {
-      cat(paste0("\nUsed 'Verbose mode' (", bold("verbose = TRUE"), "), which returns a data.frame with all specified edits.\nUse ", bold("verbose = FALSE"), " to apply the rules on your data.\n\n"))
-    }
-  }
-  
-  # Return data set ---------------------------------------------------------
-  if (verbose == TRUE) {
-    verbose_info
-  } else {
-    x_original
-  }
-}

R/extended.R

@@ -1,47 +0,0 @@
-# ==================================================================== #
-# TITLE                                                                #
-# Antimicrobial Resistance (AMR) Analysis                              #
-#                                                                      #
-# SOURCE                                                               #
-# https://gitlab.com/msberends/AMR                                     #
-#                                                                      #
-# LICENCE                                                              #
-# (c) 2019 Berends MS (m.s.berends@umcg.nl), Luz CF (c.f.luz@umcg.nl)  #
-#                                                                      #
-# This R package is free software; you can freely use and distribute   #
-# it for both personal and commercial purposes under the terms of the  #
-# GNU General Public License version 2.0 (GNU GPL-2), as published by  #
-# the Free Software Foundation.                                        #
-#                                                                      #
-# This R package was created for academic research and was publicly    #
-# released in the hope that it will be useful, but it comes WITHOUT    #
-# ANY WARRANTY OR LIABILITY.                                           #
-# Visit our website for more info: https://msberends.gitlab.io/AMR.    #
-# ==================================================================== #
-
-#' Extended functions
-#'
-#' These functions are extensions of functions in other packages.
-#' @inheritSection AMR Read more on our website!
-#' @export
-#' @keywords internal
-#' @name extended-functions
-#' @rdname extended-functions
-#' @exportMethod scale_type.mo
-#' @export
-scale_type.mo <- function(x) {
-  # fix for:
-  # "Don't know how to automatically pick scale for object of type mo. Defaulting to continuous."
-  # "Error: Discrete value supplied to continuous scale"
-  "discrete"
-}
-
-#' @rdname extended-functions
-#' @exportMethod scale_type.ab
-#' @export
-scale_type.ab <- function(x) {
-  # fix for:
-  # "Don't know how to automatically pick scale for object of type mo. Defaulting to continuous."
-  # "Error: Discrete value supplied to continuous scale"
-  "discrete"
-}

R/filter_ab_class.R

@@ -1,323 +0,0 @@
-# ==================================================================== #
-# TITLE                                                                #
-# Antimicrobial Resistance (AMR) Analysis                              #
-#                                                                      #
-# SOURCE                                                               #
-# https://gitlab.com/msberends/AMR                                     #
-#                                                                      #
-# LICENCE                                                              #
-# (c) 2019 Berends MS (m.s.berends@umcg.nl), Luz CF (c.f.luz@umcg.nl)  #
-#                                                                      #
-# This R package is free software; you can freely use and distribute   #
-# it for both personal and commercial purposes under the terms of the  #
-# GNU General Public License version 2.0 (GNU GPL-2), as published by  #
-# the Free Software Foundation.                                        #
-#                                                                      #
-# This R package was created for academic research and was publicly    #
-# released in the hope that it will be useful, but it comes WITHOUT    #
-# ANY WARRANTY OR LIABILITY.                                           #
-# Visit our website for more info: https://msberends.gitlab.io/AMR.    #
-# ==================================================================== #
-
-#' Filter isolates on result in antibiotic class
-#'
-#' Filter isolates on results in specific antibiotic variables based on their class (ATC groups). This makes it easy to get a list of isolates that were tested for e.g. any aminoglycoside.
-#' @param x a data set
-#' @param ab_class an antimicrobial class, like `"carbapenems"`, as can be found in [`AMR::antibiotics$group`][antibiotics]
-#' @param result an antibiotic result: S, I or R (or a combination of more of them)
-#' @param scope the scope to check which variables to check, can be `"any"` (default) or `"all"`
-#' @param ... parameters passed on to `filter_at` from the `dplyr` package
-#' @details The `group` column in [antibiotics] data set will be searched for `ab_class` (case-insensitive). If no results are found, the `atc_group1` and `atc_group2` columns will be searched. Next, `x` will be checked for column names with a value in any abbreviations, codes or official names found in the [antibiotics] data set.
-#' @rdname filter_ab_class
-#' @importFrom dplyr filter_at %>% select vars any_vars all_vars
-#' @importFrom crayon bold blue
-#' @export
-#' @examples
-#' library(dplyr)
-#'
-#' # filter on isolates that have any result for any aminoglycoside
-#' example_isolates %>% filter_aminoglycosides()
-#'
-#' # this is essentially the same as (but without determination of column names):
-#' example_isolates %>%
-#'   filter_at(.vars = vars(c("GEN", "TOB", "AMK", "KAN")),
-#'             .vars_predicate = any_vars(. %in% c("S", "I", "R")))
-#'
-#'
-#' # filter on isolates that show resistance to ANY aminoglycoside
-#' example_isolates %>% filter_aminoglycosides("R")
-#'
-#' # filter on isolates that show resistance to ALL aminoglycosides
-#' example_isolates %>% filter_aminoglycosides("R", "all")
-#'
-#' # filter on isolates that show resistance to
-#' # any aminoglycoside and any fluoroquinolone
-#' example_isolates %>%
-#'   filter_aminoglycosides("R") %>%
-#'   filter_fluoroquinolones("R")
-#'
-#' # filter on isolates that show resistance to
-#' # all aminoglycosides and all fluoroquinolones
-#' example_isolates %>%
-#'   filter_aminoglycosides("R", "all") %>%
-#'   filter_fluoroquinolones("R", "all")
-filter_ab_class <- function(x,
-                            ab_class,
-                            result = NULL,
-                            scope = "any",
-                            ...) {
-  scope <- scope[1L]
-  if (is.null(result)) {
-    result <- c("S", "I", "R")
-  }
-  # make result = "SI" work too:
-  result <- unlist(strsplit(result, ""))
-
-  if (!all(result %in% c("S", "I", "R"))) {
-    stop("`result` must be one or more of: S, I, R", call. = FALSE)
-  }
-  if (!all(scope %in% c("any", "all"))) {
-    stop("`scope` must be one of: any, all", call. = FALSE)
-  }
-
-  vars_df <- colnames(x)[tolower(colnames(x)) %in% tolower(ab_class_vars(ab_class))]
-  ab_group <- find_ab_group(ab_class)
-
-  if (length(vars_df) > 0) {
-    if (length(result) == 1) {
-      operator <- " is "
-    } else {
-      operator <- " is one of "
-    }
-    if (scope == "any") {
-      scope_txt <- " or "
-      scope_fn <- any_vars
-    } else {
-      scope_txt <- " and "
-      scope_fn <- all_vars
-      if (length(vars_df) > 1) {
-        operator <- gsub("is", "are", operator)
-      }
-    }
-    if (length(vars_df) > 1) {
-      scope <- paste(scope, "of columns ")
-    } else {
-      scope <- "column "
-    }
-    message(blue(paste0("Filtering on ", ab_group, ": ", scope,
-                        paste(bold(paste0("`", vars_df, "`")), collapse = scope_txt), operator, toString(result))))
-    x %>%
-      filter_at(vars(vars_df),
-                scope_fn(. %in% result),
-                ...)
-  } else {
-    warning(paste0("no antibiotics of class ", ab_group, " found, leaving data unchanged"), call. = FALSE)
-    x
-  }
-}
-
-#' @rdname filter_ab_class
-#' @export
-filter_aminoglycosides <- function(x,
-                                   result = NULL,
-                                   scope = "any",
-                                   ...) {
-  filter_ab_class(x = x,
-                  ab_class = "aminoglycoside",
-                  result = result,
-                  scope = scope,
-                  ...)
-}
-
-#' @rdname filter_ab_class
-#' @export
-filter_carbapenems <- function(x,
-                               result = NULL,
-                               scope = "any",
-                               ...) {
-  filter_ab_class(x = x,
-                  ab_class = "carbapenem",
-                  result = result,
-                  scope = scope,
-                  ...)
-}
-
-#' @rdname filter_ab_class
-#' @export
-filter_cephalosporins <- function(x,
-                                  result = NULL,
-                                  scope = "any",
-                                  ...) {
-  filter_ab_class(x = x,
-                  ab_class = "cephalosporin",
-                  result = result,
-                  scope = scope,
-                  ...)
-}
-
-#' @rdname filter_ab_class
-#' @export
-filter_1st_cephalosporins <- function(x,
-                                      result = NULL,
-                                      scope = "any",
-                                      ...) {
-  filter_ab_class(x = x,
-                  ab_class = "cephalosporins (1st gen.)",
-                  result = result,
-                  scope = scope,
-                  ...)
-}
-
-#' @rdname filter_ab_class
-#' @export
-filter_2nd_cephalosporins <- function(x,
-                                      result = NULL,
-                                      scope = "any",
-                                      ...) {
-  filter_ab_class(x = x,
-                  ab_class = "cephalosporins (2nd gen.)",
-                  result = result,
-                  scope = scope,
-                  ...)
-}
-
-#' @rdname filter_ab_class
-#' @export
-filter_3rd_cephalosporins <- function(x,
-                                      result = NULL,
-                                      scope = "any",
-                                      ...) {
-  filter_ab_class(x = x,
-                  ab_class = "cephalosporins (3rd gen.)",
-                  result = result,
-                  scope = scope,
-                  ...)
-}
-
-#' @rdname filter_ab_class
-#' @export
-filter_4th_cephalosporins <- function(x,
-                                      result = NULL,
-                                      scope = "any",
-                                      ...) {
-  filter_ab_class(x = x,
-                  ab_class = "cephalosporins (4th gen.)",
-                  result = result,
-                  scope = scope,
-                  ...)
-}
-
-#' @rdname filter_ab_class
-#' @export
-filter_5th_cephalosporins <- function(x,
-                                      result = NULL,
-                                      scope = "any",
-                                      ...) {
-  filter_ab_class(x = x,
-                  ab_class = "cephalosporins (5th gen.)",
-                  result = result,
-                  scope = scope,
-                  ...)
-}
-
-#' @rdname filter_ab_class
-#' @export
-filter_fluoroquinolones <- function(x,
-                                    result = NULL,
-                                    scope = "any",
-                                    ...) {
-  filter_ab_class(x = x,
-                  ab_class = "fluoroquinolone",
-                  result = result,
-                  scope = scope,
-                  ...)
-}
-
-#' @rdname filter_ab_class
-#' @export
-filter_glycopeptides <- function(x,
-                                 result = NULL,
-                                 scope = "any",
-                                 ...) {
-  filter_ab_class(x = x,
-                  ab_class = "glycopeptide",
-                  result = result,
-                  scope = scope,
-                  ...)
-}
-
-#' @rdname filter_ab_class
-#' @export
-filter_macrolides <- function(x,
-                              result = NULL,
-                              scope = "any",
-                              ...) {
-  filter_ab_class(x = x,
-                  ab_class = "macrolide",
-                  result = result,
-                  scope = scope,
-                  ...)
-}
-
-#' @rdname filter_ab_class
-#' @export
-filter_tetracyclines <- function(x,
-                                 result = NULL,
-                                 scope = "any",
-                                 ...) {
-  filter_ab_class(x = x,
-                  ab_class = "tetracycline",
-                  result = result,
-                  scope = scope,
-                  ...)
-}
-
-#' @importFrom dplyr %>% filter_at vars any_vars select
-ab_class_vars <- function(ab_class) {
-  ab_class <- gsub("[^a-z0-9]+", ".*", ab_class)
-  ab_vars <- AMR::antibiotics %>%
-    filter(group %like% ab_class) %>% 
-    select(ab:name, abbreviations, synonyms) %>%
-    unlist() %>%
-    as.matrix() %>%
-    as.character() %>%
-    paste(collapse = "|") %>%
-    strsplit("|", fixed = TRUE) %>%
-    unlist() %>%
-    unique()
-  ab_vars <- ab_vars[!ab_vars %in% c(NA, "", "NA") & nchar(ab_vars) > 2]
-  if (length(ab_vars) == 0) {
-    # try again, searching atc_group1 and atc_group2 columns
-    ab_vars <- AMR::antibiotics %>%
-      filter_at(vars(c("atc_group1", "atc_group2")), any_vars(. %like% ab_class)) %>% 
-      select(ab:name, abbreviations, synonyms) %>%
-      unlist() %>%
-      as.matrix() %>%
-      as.character() %>%
-      paste(collapse = "|") %>%
-      strsplit("|", fixed = TRUE) %>%
-      unlist() %>%
-      unique()
-    ab_vars <- ab_vars[!ab_vars %in% c(NA, "", "NA") & nchar(ab_vars) > 2]
-  }
-  ab_vars
-}
-
-#' @importFrom dplyr %>% filter pull
-find_ab_group <- function(ab_class) {
-  ifelse(ab_class %in% c("aminoglycoside",
-                         "carbapenem",
-                         "cephalosporin",
-                         "fluoroquinolone",
-                         "glycopeptide",
-                         "macrolide",
-                         "tetracycline"),
-         paste0(ab_class, "s"),
-         AMR::antibiotics %>%
-           filter(ab %in% ab_class_vars(ab_class)) %>%
-           pull(group) %>%
-           unique() %>%
-           tolower() %>%
-           paste(collapse = "/")
-  )
-}

R/first_isolate.R

@@ -1,543 +0,0 @@
-# ==================================================================== #
-# TITLE                                                                #
-# Antimicrobial Resistance (AMR) Analysis                              #
-#                                                                      #
-# SOURCE                                                               #
-# https://gitlab.com/msberends/AMR                                     #
-#                                                                      #
-# LICENCE                                                              #
-# (c) 2019 Berends MS (m.s.berends@umcg.nl), Luz CF (c.f.luz@umcg.nl)  #
-#                                                                      #
-# This R package is free software; you can freely use and distribute   #
-# it for both personal and commercial purposes under the terms of the  #
-# GNU General Public License version 2.0 (GNU GPL-2), as published by  #
-# the Free Software Foundation.                                        #
-#                                                                      #
-# This R package was created for academic research and was publicly    #
-# released in the hope that it will be useful, but it comes WITHOUT    #
-# ANY WARRANTY OR LIABILITY.                                           #
-# Visit our website for more info: https://msberends.gitlab.io/AMR.    #
-# ==================================================================== #
-
-#' Determine first (weighted) isolates
-#'
-#' Determine first (weighted) isolates of all microorganisms of every patient per episode and (if needed) per specimen type.
-#' @param x a [`data.frame`] containing isolates.
-#' @param col_date column name of the result date (or date that is was received on the lab), defaults to the first column of with a date class
-#' @param col_patient_id column name of the unique IDs of the patients, defaults to the first column that starts with 'patient' or 'patid' (case insensitive)
-#' @param col_mo column name of the IDs of the microorganisms (see [as.mo()]), defaults to the first column of class [`mo`]. Values will be coerced using [as.mo()].
-#' @param col_testcode column name of the test codes. Use `col_testcode = NULL` to **not** exclude certain test codes (like test codes for screening). In that case `testcodes_exclude` will be ignored.
-#' @param col_specimen column name of the specimen type or group
-#' @param col_icu column name of the logicals (`TRUE`/`FALSE`) whether a ward or department is an Intensive Care Unit (ICU)
-#' @param col_keyantibiotics column name of the key antibiotics to determine first *weighted* isolates, see [key_antibiotics()]. Defaults to the first column that starts with 'key' followed by 'ab' or 'antibiotics' (case insensitive). Use `col_keyantibiotics = FALSE` to prevent this.
-#' @param episode_days episode in days after which a genus/species combination will be determined as 'first isolate' again. The default of 365 days is based on the guideline by CLSI, see Source. 
-#' @param testcodes_exclude character vector with test codes that should be excluded (case-insensitive)
-#' @param icu_exclude logical whether ICU isolates should be excluded (rows with value `TRUE` in column `col_icu`)
-#' @param specimen_group value in column `col_specimen` to filter on
-#' @param type type to determine weighed isolates; can be `"keyantibiotics"` or `"points"`, see Details
-#' @param ignore_I logical to determine whether antibiotic interpretations with `"I"` will be ignored when `type = "keyantibiotics"`, see Details
-#' @param points_threshold points until the comparison of key antibiotics will lead to inclusion of an isolate when `type = "points"`, see Details
-#' @param info print progress
-#' @param include_unknown logical to determine whether 'unknown' microorganisms should be included too, i.e. microbial code `"UNKNOWN"`, which defaults to `FALSE`. For WHONET users, this means that all records with organism code `"con"` (*contamination*) will be excluded at default. Isolates with a microbial ID of `NA` will always be excluded as first isolate.
-#' @param ... parameters passed on to the [first_isolate()] function
-#' @details **WHY THIS IS SO IMPORTANT** \cr
-#' To conduct an analysis of antimicrobial resistance, you should only include the first isolate of every patient per episode [(ref)](https://www.ncbi.nlm.nih.gov/pubmed/17304462). If you would not do this, you could easily get an overestimate or underestimate of the resistance of an antibiotic. Imagine that a patient was admitted with an MRSA and that it was found in 5 different blood cultures the following week. The resistance percentage of oxacillin of all *S. aureus* isolates would be overestimated, because you included this MRSA more than once. It would be [selection bias](https://en.wikipedia.org/wiki/Selection_bias).
-#'
-#' All isolates with a microbial ID of `NA` will be excluded as first isolate.
-#'
-#' The functions [filter_first_isolate()] and [filter_first_weighted_isolate()] are helper functions to quickly filter on first isolates. The function [filter_first_isolate()] is essentially equal to:
-#' ```
-#'  x %>%
-#'    mutate(only_firsts = first_isolate(x, ...)) %>%
-#'    filter(only_firsts == TRUE) %>%
-#'    select(-only_firsts)
-#' ```
-#' The function [filter_first_weighted_isolate()] is essentially equal to:
-#' ```
-#'  x %>%
-#'    mutate(keyab = key_antibiotics(.)) %>%
-#'    mutate(only_weighted_firsts = first_isolate(x,
-#'                                                col_keyantibiotics = "keyab", ...)) %>%
-#'    filter(only_weighted_firsts == TRUE) %>%
-#'    select(-only_weighted_firsts)
-#' ```
-#' @section Key antibiotics:
-#' There are two ways to determine whether isolates can be included as first *weighted* isolates which will give generally the same results:
-#'
-#' 1. Using `type = "keyantibiotics"` and parameter `ignore_I`
-#' 
-#'    Any difference from S to R (or vice versa) will (re)select an isolate as a first weighted isolate. With `ignore_I = FALSE`, also differences from I to S|R (or vice versa) will lead to this. This is a reliable method and 30-35 times faster than method 2. Read more about this in the [key_antibiotics()] function.
-#'    
-#' 2. Using `type = "points"` and parameter `points_threshold`
-#' 
-#'    A difference from I to S|R (or vice versa) means 0.5 points, a difference from S to R (or vice versa) means 1 point. When the sum of points exceeds `points_threshold`, which default to `2`, an isolate will be (re)selected as a first weighted isolate.
-#' @rdname first_isolate
-#' @seealso [key_antibiotics()]
-#' @export
-#' @importFrom dplyr arrange_at lag between row_number filter mutate arrange pull ungroup
-#' @importFrom crayon blue bold silver
-# @importFrom clean percentage
-#' @return A [`logical`] vector
-#' @source Methodology of this function is based on:
-#' 
-#' **M39 Analysis and Presentation of Cumulative Antimicrobial Susceptibility Test Data, 4th Edition**, 2014, *Clinical and Laboratory Standards Institute (CLSI)*. <https://clsi.org/standards/products/microbiology/documents/m39/>.
-#' @inheritSection AMR Read more on our website!
-#' @examples
-#' # `example_isolates` is a dataset available in the AMR package.
-#' # See ?example_isolates.
-#'
-#' library(dplyr)
-#' # Filter on first isolates:
-#' example_isolates %>%
-#'   mutate(first_isolate = first_isolate(.,
-#'                                        col_date = "date",
-#'                                        col_patient_id = "patient_id",
-#'                                        col_mo = "mo")) %>%
-#'   filter(first_isolate == TRUE)
-#'
-#' # Which can be shortened to:
-#' example_isolates %>%
-#'   filter_first_isolate()
-#' # or for first weighted isolates:
-#' example_isolates %>%
-#'   filter_first_weighted_isolate()
-#' 
-#' # Now let's see if first isolates matter:
-#' A <- example_isolates %>%
-#'   group_by(hospital_id) %>%
-#'   summarise(count = n_rsi(GEN),            # gentamicin availability
-#'             resistance = resistance(GEN))  # gentamicin resistance
-#'
-#' B <- example_isolates %>%
-#'   filter_first_weighted_isolate() %>%      # the 1st isolate filter
-#'   group_by(hospital_id) %>%
-#'   summarise(count = n_rsi(GEN),            # gentamicin availability
-#'             resistance = resistance(GEN))  # gentamicin resistance
-#'
-#' # Have a look at A and B.
-#' # B is more reliable because every isolate is only counted once.
-#' # Gentamicin resitance in hospital D appears to be 3.1% higher than
-#' # when you (erroneously) would have used all isolates for analysis.
-#'
-#'
-#' ## OTHER EXAMPLES:
-#'
-#' \dontrun{
-#'
-#' # set key antibiotics to a new variable
-#' x$keyab <- key_antibiotics(x)
-#'
-#' x$first_isolate <- first_isolate(x)
-#'
-#' x$first_isolate_weighed <- first_isolate(x, col_keyantibiotics = 'keyab')
-#'
-#' x$first_blood_isolate <- first_isolate(x, specimen_group = "Blood")
-#' }
-first_isolate <- function(x,
-                          col_date = NULL,
-                          col_patient_id = NULL,
-                          col_mo = NULL,
-                          col_testcode = NULL,
-                          col_specimen = NULL,
-                          col_icu = NULL,
-                          col_keyantibiotics = NULL,
-                          episode_days = 365,
-                          testcodes_exclude = NULL,
-                          icu_exclude = FALSE,
-                          specimen_group = NULL,
-                          type = "keyantibiotics",
-                          ignore_I = TRUE,
-                          points_threshold = 2,
-                          info = TRUE,
-                          include_unknown = FALSE,
-                          ...) {
-  
-  if (!is.data.frame(x)) {
-    stop("`x` must be a data.frame.", call. = FALSE)
-  }
-  
-  dots <- unlist(list(...))
-  if (length(dots) != 0) {
-    # backwards compatibility with old parameters
-    dots.names <- dots %>% names()
-    if ("filter_specimen" %in% dots.names) {
-      specimen_group <- dots[which(dots.names == "filter_specimen")]
-    }
-    if ("tbl" %in% dots.names) {
-      x <- dots[which(dots.names == "tbl")]
-    }
-  }
-  
-  # try to find columns based on type
-  # -- mo
-  if (is.null(col_mo)) {
-    col_mo <- search_type_in_df(x = x, type = "mo")
-  }
-  if (is.null(col_mo)) {
-    stop("`col_mo` must be set.", call. = FALSE)
-  }
-  
-  # -- date
-  if (is.null(col_date)) {
-    col_date <- search_type_in_df(x = x, type = "date")
-  }
-  if (is.null(col_date)) {
-    stop("`col_date` must be set.", call. = FALSE)
-  }
-  # convert to Date (pipes/pull for supporting tibbles too)
-  dates <- x %>% pull(col_date) %>% as.Date()
-  dates[is.na(dates)] <- as.Date("1970-01-01")
-  x[, col_date] <- dates
-  
-  # -- patient id
-  if (is.null(col_patient_id)) {
-    if (all(c("First name", "Last name", "Sex") %in% colnames(x))) {
-      # WHONET support
-      x <- x %>% mutate(patient_id = paste(`First name`, `Last name`, Sex))
-      col_patient_id <- "patient_id"
-      message(blue(paste0("NOTE: Using combined columns `", bold("First name"), "`, `", bold("Last name"), "` and `", bold("Sex"), "` as input for `col_patient_id`")))
-    } else {
-      col_patient_id <- search_type_in_df(x = x, type = "patient_id")
-    }
-  }
-  if (is.null(col_patient_id)) {
-    stop("`col_patient_id` must be set.", call. = FALSE)
-  }
-  
-  # -- key antibiotics
-  if (is.null(col_keyantibiotics)) {
-    col_keyantibiotics <- search_type_in_df(x = x, type = "keyantibiotics")
-  }
-  if (isFALSE(col_keyantibiotics)) {
-    col_keyantibiotics <- NULL
-  }
-  
-  # -- specimen
-  if (is.null(col_specimen) & !is.null(specimen_group)) {
-    col_specimen <- search_type_in_df(x = x, type = "specimen")
-  }
-  if (isFALSE(col_specimen)) {
-    col_specimen <- NULL
-  }
-  
-  # check if columns exist
-  check_columns_existance <- function(column, tblname = x) {
-    if (NROW(tblname) <= 1 | NCOL(tblname) <= 1) {
-      stop("Please check tbl for existance.")
-    }
-    
-    if (!is.null(column)) {
-      if (!(column %in% colnames(tblname))) {
-        stop("Column `", column, "` not found.")
-      }
-    }
-  }
-  
-  check_columns_existance(col_date)
-  check_columns_existance(col_patient_id)
-  check_columns_existance(col_mo)
-  check_columns_existance(col_testcode)
-  check_columns_existance(col_icu)
-  check_columns_existance(col_keyantibiotics)
-  
-  # create new dataframe with original row index
-  x <- x %>%
-    mutate(newvar_row_index = seq_len(nrow(x)),
-           newvar_mo = x %>% pull(col_mo) %>% as.mo(),
-           newvar_genus_species = paste(mo_genus(newvar_mo), mo_species(newvar_mo)),
-           newvar_date = x %>% pull(col_date),
-           newvar_patient_id = x %>% pull(col_patient_id))
-  
-  if (is.null(col_testcode)) {
-    testcodes_exclude <- NULL
-  }
-  # remove testcodes
-  if (!is.null(testcodes_exclude) & info == TRUE) {
-    message(blue(paste0("[Criterion] Excluded test codes: ", toString(testcodes_exclude))))
-  }
-  
-  if (is.null(col_icu)) {
-    icu_exclude <- FALSE
-  } else {
-    x <- x %>%
-      mutate(col_icu = x %>% pull(col_icu) %>% as.logical())
-  }
-  
-  if (is.null(col_specimen)) {
-    specimen_group <- NULL
-  }
-  
-  # filter on specimen group and keyantibiotics when they are filled in
-  if (!is.null(specimen_group)) {
-    check_columns_existance(col_specimen, x)
-    if (info == TRUE) {
-      message(blue(paste0("[Criterion] Excluded other than specimen group '", specimen_group, "'")))
-    }
-  }
-  if (!is.null(col_keyantibiotics)) {
-    x <- x %>% mutate(key_ab = x %>% pull(col_keyantibiotics))
-  }
-  
-  if (is.null(testcodes_exclude)) {
-    testcodes_exclude <- ""
-  }
-  
-  # arrange data to the right sorting
-  if (is.null(specimen_group)) {
-    # not filtering on specimen
-    if (icu_exclude == FALSE) {
-      if (info == TRUE & !is.null(col_icu)) {
-        message(blue("[Criterion] Included isolates from ICU"))
-      }
-      x <- x %>%
-        arrange(newvar_patient_id,
-                newvar_genus_species,
-                newvar_date)
-      row.start <- 1
-      row.end <- nrow(x)
-    } else {
-      if (info == TRUE) {
-        message(blue("[Criterion] Excluded isolates from ICU"))
-      }
-      x <- x %>%
-        arrange_at(c(col_icu,
-                     "newvar_patient_id",
-                     "newvar_genus_species",
-                     "newvar_date"))
-      
-      suppressWarnings(
-        row.start <- which(x %>% pull(col_icu) == FALSE) %>% min(na.rm = TRUE)
-      )
-      suppressWarnings(
-        row.end <- which(x %>% pull(col_icu) == FALSE) %>% max(na.rm = TRUE)
-      )
-    }
-    
-  } else {
-    # filtering on specimen and only analyse these row to save time
-    if (icu_exclude == FALSE) {
-      if (info == TRUE & !is.null(col_icu)) {
-        message(blue("[Criterion] Included isolates from ICU.\n"))
-      }
-      x <- x %>%
-        arrange_at(c(col_specimen,
-                     "newvar_patient_id",
-                     "newvar_genus_species",
-                     "newvar_date"))
-      suppressWarnings(
-        row.start <- which(x %>% pull(col_specimen) == specimen_group) %>% min(na.rm = TRUE)
-      )
-      suppressWarnings(
-        row.end <- which(x %>% pull(col_specimen) == specimen_group) %>% max(na.rm = TRUE)
-      )
-    } else {
-      if (info == TRUE) {
-        message(blue("[Criterion] Excluded isolates from ICU"))
-      }
-      x <- x %>%
-        arrange_at(c(col_icu,
-                     col_specimen,
-                     "newvar_patient_id",
-                     "newvar_genus_species",
-                     "newvar_date"))
-      suppressWarnings(
-        row.start <- min(which(x %>% pull(col_specimen) == specimen_group
-                               & x %>% pull(col_icu) == FALSE), 
-                         na.rm = TRUE)
-      )
-      suppressWarnings(
-        row.end <- max(which(x %>% pull(col_specimen) == specimen_group & 
-                               x %>% pull(col_icu) == FALSE),
-                       na.rm = TRUE)
-      )
-    }
-    
-  }
-  
-  # no isolates found
-  if (abs(row.start) == Inf | abs(row.end) == Inf) {
-    if (info == TRUE) {
-      message(paste("=> Found", bold("no isolates")))
-    }
-    return(rep(FALSE, nrow(x)))
-  }
-  
-  # did find some isolates - add new index numbers of rows
-  x <- x %>% mutate(newvar_row_index_sorted = seq_len(nrow(.)))
-  
-  scope.size <- row.end - row.start + 1
-  
-  identify_new_year <- function(x, episode_days) {
-    # I asked on StackOverflow:
-    # https://stackoverflow.com/questions/42122245/filter-one-row-every-year
-    if (length(x) == 1) {
-      return(TRUE)
-    }
-    indices <- integer(0)
-    start <- x[1]
-    ind <- 1
-    indices[ind] <- ind
-    for (i in 2:length(x)) {
-      if (isTRUE(as.numeric(x[i] - start) >= episode_days)) {
-        ind <- ind + 1
-        indices[ind] <- i
-        start <- x[i]
-      }
-    }
-    result <- rep(FALSE, length(x))
-    result[indices] <- TRUE
-    return(result)
-  }
-  
-  # Analysis of first isolate ----
-  all_first <- x %>%
-    mutate(other_pat_or_mo = if_else(newvar_patient_id == lag(newvar_patient_id)
-                                     & newvar_genus_species == lag(newvar_genus_species),
-                                     FALSE,
-                                     TRUE)) %>%
-    group_by(newvar_patient_id,
-             newvar_genus_species) %>%
-    mutate(more_than_episode_ago = identify_new_year(x = newvar_date,
-                                                     episode_days = episode_days)) %>%
-    ungroup()
-  
-  weighted.notice <- ""
-  if (!is.null(col_keyantibiotics)) {
-    weighted.notice <- "weighted "
-    if (info == TRUE) {
-      if (type == "keyantibiotics") {
-        message(blue(paste0("[Criterion] Inclusion based on key antibiotics, ",
-                            ifelse(ignore_I == FALSE, "not ", ""),
-                            "ignoring I")))
-      }
-      if (type == "points") {
-        message(blue(paste0("[Criterion] Inclusion based on key antibiotics, using points threshold of "
-                            , points_threshold)))
-      }
-    }
-    type_param <- type
-    
-    all_first <- all_first %>%
-      mutate(key_ab_lag = lag(key_ab)) %>%
-      mutate(key_ab_other = !key_antibiotics_equal(y = key_ab,
-                                                   z = key_ab_lag,
-                                                   type = type_param,
-                                                   ignore_I = ignore_I,
-                                                   points_threshold = points_threshold,
-                                                   info = info)) %>%
-      mutate(
-        real_first_isolate =
-          if_else(
-            newvar_row_index_sorted %>% between(row.start, row.end)
-            & newvar_genus_species != ""
-            & (other_pat_or_mo | more_than_episode_ago | key_ab_other),
-            TRUE,
-            FALSE))
-    
-  } else {
-    # no key antibiotics
-    all_first <- all_first %>%
-      mutate(
-        real_first_isolate =
-          if_else(
-            newvar_row_index_sorted %>% between(row.start, row.end)
-            & newvar_genus_species != ""
-            & (other_pat_or_mo | more_than_episode_ago),
-            TRUE,
-            FALSE))
-    
-  }
-  
-  # first one as TRUE
-  all_first[row.start, "real_first_isolate"] <- TRUE
-  # no tests that should be included, or ICU
-  if (!is.null(col_testcode)) {
-    all_first[which(all_first[, col_testcode] %in% tolower(testcodes_exclude)), "real_first_isolate"] <- FALSE
-  }
-  if (icu_exclude == TRUE) {
-    all_first[which(all_first[, col_icu] == TRUE), "real_first_isolate"] <- FALSE
-  }
-  
-  decimal.mark <- getOption("OutDec")
-  big.mark <- ifelse(decimal.mark != ",", ",", ".")
-  
-  # handle empty microorganisms
-  if (any(all_first$newvar_mo == "UNKNOWN", na.rm = TRUE) & info == TRUE) {
-    message(blue(paste0("NOTE: ", ifelse(include_unknown == TRUE, "Included ", "Excluded "), 
-                        format(sum(all_first$newvar_mo == "UNKNOWN"),
-                               decimal.mark = decimal.mark, big.mark = big.mark), 
-                        " isolates with a microbial ID 'UNKNOWN' (column `", bold(col_mo), "`)")))
-  }
-  all_first[which(all_first$newvar_mo == "UNKNOWN"), "real_first_isolate"] <- include_unknown
-  
-  # exclude all NAs
-  if (any(is.na(all_first$newvar_mo)) & info == TRUE) {
-    message(blue(paste0("NOTE: Excluded ", format(sum(is.na(all_first$newvar_mo)),
-                                                  decimal.mark = decimal.mark, big.mark = big.mark), 
-                        " isolates with a microbial ID 'NA' (column `", bold(col_mo), "`)")))
-  }
-  all_first[which(is.na(all_first$newvar_mo)), "real_first_isolate"] <- FALSE
-  
-  # arrange back according to original sorting again
-  all_first <- all_first %>%
-    arrange(newvar_row_index) %>%
-    pull(real_first_isolate)
-  
-  if (info == TRUE) {
-    n_found <- base::sum(all_first, na.rm = TRUE)
-    p_found_total <- percentage(n_found / nrow(x))
-    p_found_scope <- percentage(n_found / scope.size)
-    # mark up number of found
-    n_found <- base::format(n_found, big.mark = big.mark, decimal.mark = decimal.mark)
-    if (p_found_total != p_found_scope) {
-      msg_txt <- paste0("=> Found ",
-                        bold(paste0(n_found, " first ", weighted.notice, "isolates")),
-                        " (", p_found_scope, " within scope and ", p_found_total, " of total)")
-    } else {
-      msg_txt <- paste0("=> Found ",
-                        bold(paste0(n_found, " first ", weighted.notice, "isolates")),
-                        " (", p_found_total, " of total)")
-    }
-    base::message(msg_txt)
-  }
-  
-  all_first
-  
-}
-
-#' @rdname first_isolate
-#' @importFrom dplyr filter
-#' @export
-filter_first_isolate <- function(x,
-                                 col_date = NULL,
-                                 col_patient_id = NULL,
-                                 col_mo = NULL,
-                                 ...) {
-  filter(x, first_isolate(x = x,
-                          col_date = col_date,
-                          col_patient_id = col_patient_id,
-                          col_mo = col_mo,
-                          ...))
-}
-
-#' @rdname first_isolate
-#' @importFrom dplyr %>% mutate filter
-#' @export
-filter_first_weighted_isolate <- function(x,
-                                          col_date = NULL,
-                                          col_patient_id = NULL,
-                                          col_mo = NULL,
-                                          col_keyantibiotics = NULL,
-                                          ...) {
-  tbl_keyab <- x %>%
-    mutate(keyab = suppressMessages(key_antibiotics(.,
-                                                    col_mo = col_mo,
-                                                    ...))) %>%
-    mutate(firsts = first_isolate(.,
-                                  col_date = col_date,
-                                  col_patient_id = col_patient_id,
-                                  col_mo = col_mo,
-                                  col_keyantibiotics = "keyab",
-                                  ...))
-  x[which(tbl_keyab$firsts == TRUE), ]
-}

R/freq.R

@@ -1,71 +0,0 @@
-# ==================================================================== #
-# TITLE                                                                #
-# Antimicrobial Resistance (AMR) Analysis                              #
-#                                                                      #
-# SOURCE                                                               #
-# https://gitlab.com/msberends/AMR                                     #
-#                                                                      #
-# LICENCE                                                              #
-# (c) 2019 Berends MS (m.s.berends@umcg.nl), Luz CF (c.f.luz@umcg.nl)  #
-#                                                                      #
-# This R package is free software; you can freely use and distribute   #
-# it for both personal and commercial purposes under the terms of the  #
-# GNU General Public License version 2.0 (GNU GPL-2), as published by  #
-# the Free Software Foundation.                                        #
-#                                                                      #
-# This R package was created for academic research and was publicly    #
-# released in the hope that it will be useful, but it comes WITHOUT    #
-# ANY WARRANTY OR LIABILITY.                                           #
-# Visit our website for more info: https://msberends.gitlab.io/AMR.    #
-# ==================================================================== #
-
-#' @importFrom cleaner freq
-#' @export
-cleaner::freq
-
-#' @exportMethod freq.mo
-#' @importFrom dplyr n_distinct
-#' @importFrom cleaner freq.default percentage
-#' @export
-#' @noRd
-freq.mo <- function(x, ...) {
-  x_noNA <- as.mo(x[!is.na(x)]) # as.mo() to get the newest mo codes
-  grams <- mo_gramstain(x_noNA, language = NULL)
-  digits <- list(...)$digits
-  if (is.null(digits)) {
-    digits <- 2
-  }
-  freq.default(x = x, ...,
-               .add_header = list(`Gram-negative` = paste0(format(sum(grams == "Gram-negative", na.rm = TRUE),
-                                                                  big.mark = ",",
-                                                                  decimal.mark = "."),
-                                                           " (", percentage(sum(grams == "Gram-negative", na.rm = TRUE) / length(grams), digits = digits),
-                                                           ")"),
-                                  `Gram-positive` = paste0(format(sum(grams == "Gram-positive", na.rm = TRUE),
-                                                                  big.mark = ",",
-                                                                  decimal.mark = "."),
-                                                           " (", percentage(sum(grams == "Gram-positive", na.rm = TRUE) / length(grams), digits = digits),
-                                                           ")"),
-                                  `No of genera` = n_distinct(mo_genus(x_noNA, language = NULL)),
-                                  `No of species` = n_distinct(paste(mo_genus(x_noNA, language = NULL),
-                                                             mo_species(x_noNA, language = NULL)))))
-}
-
-#' @exportMethod freq.rsi
-#' @importFrom cleaner freq.default
-#' @export
-#' @noRd
-freq.rsi <- function(x, ...) {
-  x_name <- deparse(substitute(x))
-  x_name <- gsub(".*[$]", "", x_name)
-  ab <- suppressMessages(suppressWarnings(AMR::as.ab(x_name)))
-  if (!is.na(ab)) {
-    freq.default(x = x, ...,
-                 .add_header = list(Drug = paste0(ab_name(ab), " (", ab, ", ", ab_atc(ab), ")"),
-                                    group = ab_group(ab),
-                                    `%SI` = AMR::susceptibility(x, minimum = 0, as_percent = TRUE)))
-  } else {
-    freq.default(x = x, ...,
-                 .add_header = list(`%SI` = AMR::susceptibility(x, minimum = 0, as_percent = TRUE)))
-  }
-}

R/g.test.R

@@ -1,202 +0,0 @@
-# ==================================================================== #
-# TITLE                                                                #
-# Antimicrobial Resistance (AMR) Analysis                              #
-#                                                                      #
-# SOURCE                                                               #
-# https://gitlab.com/msberends/AMR                                     #
-#                                                                      #
-# LICENCE                                                              #
-# (c) 2019 Berends MS (m.s.berends@umcg.nl), Luz CF (c.f.luz@umcg.nl)  #
-#                                                                      #
-# This R package is free software; you can freely use and distribute   #
-# it for both personal and commercial purposes under the terms of the  #
-# GNU General Public License version 2.0 (GNU GPL-2), as published by  #
-# the Free Software Foundation.                                        #
-#                                                                      #
-# This R package was created for academic research and was publicly    #
-# released in the hope that it will be useful, but it comes WITHOUT    #
-# ANY WARRANTY OR LIABILITY.                                           #
-# Visit our website for more info: https://msberends.gitlab.io/AMR.    #
-# ==================================================================== #
-
-#' *G*-test for Count Data
-#'
-#' [g.test()] performs chi-squared contingency table tests and goodness-of-fit tests, just like [chisq.test()] but is more reliable (1). A *G*-test can be used to see whether the number of observations in each category fits a theoretical expectation (called a ***G*-test of goodness-of-fit**), or to see whether the proportions of one variable are different for different values of the other variable (called a ***G*-test of independence**).
-#' @inherit stats::chisq.test params return
-#' @details If `x` is a matrix with one row or column, or if `x` is a vector and `y` is not given, then a *goodness-of-fit test* is performed (`x` is treated as a one-dimensional contingency table). The entries of `x` must be non-negative integers. In this case, the hypothesis tested is whether the population probabilities equal those in `p`, or are all equal if `p` is not given.
-#'
-#' If `x` is a matrix with at least two rows and columns, it is taken as a two-dimensional contingency table: the entries of `x` must be non-negative integers.  Otherwise, `x` and `y` must be vectors or factors of the same length; cases with missing values are removed, the objects are coerced to factors, and the contingency table is computed from these.  Then Pearson's chi-squared test is performed of the null hypothesis that the joint distribution of the cell counts in a 2-dimensional contingency table is the product of the row and column marginals.
-#'
-#' The p-value is computed from the asymptotic chi-squared distribution of the test statistic.
-#'
-#' In the contingency table case simulation is done by random sampling from the set of all contingency tables with given marginals, and works only if the marginals are strictly positive. Note that this is not the usual sampling situation assumed for a chi-squared test (like the *G*-test) but rather that for Fisher's exact test.
-#'
-#' In the goodness-of-fit case simulation is done by random sampling from the discrete distribution specified by `p`, each sample being of size `n = sum(x)`. This simulation is done in \R and may be slow.
-#'   
-#' ## *G*-test of goodness-of-fit (likelihood ratio test)
-#' Use the *G*-test of goodness-of-fit when you have one nominal variable with two or more values (such as male and female, or red, pink and white flowers). You compare the observed counts of numbers of observations in each category with the expected counts, which you calculate using some kind of theoretical expectation (such as a 1:1 sex ratio or a 1:2:1 ratio in a genetic cross).
-#'
-#' If the expected number of observations in any category is too small, the *G*-test may give inaccurate results, and you should use an exact test instead ([fisher.test()]).
-#'
-#' The *G*-test of goodness-of-fit is an alternative to the chi-square test of goodness-of-fit ([chisq.test()]); each of these tests has some advantages and some disadvantages, and the results of the two tests are usually very similar.
-#'
-#' ## *G*-test of independence
-#' Use the *G*-test of independence when you have two nominal variables, each with two or more possible values. You want to know whether the proportions for one variable are different among values of the other variable.
-#'
-#' It is also possible to do a *G*-test of independence with more than two nominal variables. For example, Jackson et al. (2013) also had data for children under 3, so you could do an analysis of old vs. young, thigh vs. arm, and reaction vs. no reaction, all analyzed together.
-#'
-#' Fisher's exact test ([fisher.test()]) is an **exact** test, where the *G*-test is still only an **approximation**. For any 2x2 table, Fisher's Exact test may be slower but will still run in seconds, even if the sum of your observations is multiple millions.
-#'
-#' The *G*-test of independence is an alternative to the chi-square test of independence ([chisq.test()]), and they will give approximately the same results.
-#'
-#' ## How the test works
-#' Unlike the exact test of goodness-of-fit ([fisher.test()]), the *G*-test does not directly calculate the probability of obtaining the observed results or something more extreme. Instead, like almost all statistical tests, the *G*-test has an intermediate step; it uses the data to calculate a test statistic that measures how far the observed data are from the null expectation. You then use a mathematical relationship, in this case the chi-square distribution, to estimate the probability of obtaining that value of the test statistic.
-#'
-#' The *G*-test uses the log of the ratio of two likelihoods as the test statistic, which is why it is also called a likelihood ratio test or log-likelihood ratio test. The formula to calculate a *G*-statistic is:
-#' 
-#' \eqn{G = 2 * sum(x * log(x / E))}
-#' 
-#' where `E` are the expected values. Since this is chi-square distributed, the p value can be calculated in \R with:
-#' ```
-#' p <- stats::pchisq(G, df, lower.tail = FALSE)
-#' ```
-#' where `df` are the degrees of freedom.
-#'
-#' If there are more than two categories and you want to find out which ones are significantly different from their null expectation, you can use the same method of testing each category vs. the sum of all categories, with the Bonferroni correction. You use *G*-tests for each category, of course.
-#' @seealso [chisq.test()]
-#' @references 1. McDonald, J.H. 2014. **Handbook of Biological Statistics (3rd ed.)**. Sparky House Publishing, Baltimore, Maryland. <http://www.biostathandbook.com/gtestgof.html>.
-#' @source The code for this function is identical to that of [chisq.test()], except that:
-#' - The calculation of the statistic was changed to \eqn{2 * sum(x * log(x / E))}
-#' - Yates' continuity correction was removed as it does not apply to a *G*-test
-#' - The possibility to simulate p values with `simulate.p.value` was removed
-#' @export
-#' @importFrom stats pchisq complete.cases
-#' @inheritSection AMR Read more on our website!
-#' @examples
-#' # = EXAMPLE 1 =
-#' # Shivrain et al. (2006) crossed clearfield rice (which are resistant
-#' # to the herbicide imazethapyr) with red rice (which are susceptible to
-#' # imazethapyr). They then crossed the hybrid offspring and examined the
-#' # F2 generation, where they found 772 resistant plants, 1611 moderately
-#' # resistant plants, and 737 susceptible plants. If resistance is controlled
-#' # by a single gene with two co-dominant alleles, you would expect a 1:2:1
-#' # ratio.
-#'
-#' x <- c(772, 1611, 737)
-#' G <- g.test(x, p = c(1, 2, 1) / 4)
-#' # G$p.value = 0.12574.
-#'
-#' # There is no significant difference from a 1:2:1 ratio.
-#' # Meaning: resistance controlled by a single gene with two co-dominant
-#' # alleles, is plausible.
-#'
-#'
-#' # = EXAMPLE 2 =
-#' # Red crossbills (Loxia curvirostra) have the tip of the upper bill either
-#' # right or left of the lower bill, which helps them extract seeds from pine
-#' # cones. Some have hypothesized that frequency-dependent selection would
-#' # keep the number of right and left-billed birds at a 1:1 ratio. Groth (1992)
-#' # observed 1752 right-billed and 1895 left-billed crossbills.
-#'
-#' x <- c(1752, 1895)
-#' g.test(x)
-#' # p = 0.01787343
-#'
-#' # There is a significant difference from a 1:1 ratio.
-#' # Meaning: there are significantly more left-billed birds.
-#'
-g.test <- function(x,
-                   y = NULL,
-                   # correct = TRUE,
-                   p = rep(1 / length(x), length(x)),
-                   rescale.p = FALSE) {
-  DNAME <- deparse(substitute(x))
-  if (is.data.frame(x))
-    x <- as.matrix(x)
-  if (is.matrix(x)) {
-    if (min(dim(x)) == 1L)
-      x <- as.vector(x)
-  }
-  if (!is.matrix(x) && !is.null(y)) {
-    if (length(x) != length(y))
-      stop("'x' and 'y' must have the same length")
-    DNAME2 <- deparse(substitute(y))
-    xname <- if (length(DNAME) > 1L || nchar(DNAME, "w") >
-                 30)
-      ""
-    else DNAME
-    yname <- if (length(DNAME2) > 1L || nchar(DNAME2, "w") >
-                 30)
-      ""
-    else DNAME2
-    OK <- complete.cases(x, y)
-    x <- factor(x[OK])
-    y <- factor(y[OK])
-    if ((nlevels(x) < 2L) || (nlevels(y) < 2L))
-      stop("'x' and 'y' must have at least 2 levels")
-    x <- table(x, y)
-    names(dimnames(x)) <- c(xname, yname)
-    DNAME <- paste(paste(DNAME, collapse = "\n"), "and",
-                   paste(DNAME2, collapse = "\n"))
-  }
-  if (any(x < 0) || anyNA(x))
-    stop("all entries of 'x' must be nonnegative and finite")
-  if ((n <- sum(x)) == 0)
-    stop("at least one entry of 'x' must be positive")
-  
-  
-  if (is.matrix(x)) {
-    METHOD <- "G-test of independence"
-    nr <- as.integer(nrow(x))
-    nc <- as.integer(ncol(x))
-    if (is.na(nr) || is.na(nc) || is.na(nr * nc))
-      stop("invalid nrow(x) or ncol(x)", domain = NA)
-    # add fisher.test suggestion
-    if (nr == 2 && nc == 2)
-      warning("`fisher.test()` is always more reliable for 2x2 tables and although much slower, often only takes seconds.")
-    sr <- rowSums(x)
-    sc <- colSums(x)
-    E <- outer(sr, sc, "*") / n
-    v <- function(r, c, n) c * r * (n - r) * (n - c) / n ^ 3
-    V <- outer(sr, sc, v, n)
-    dimnames(E) <- dimnames(x)
-    
-    STATISTIC <- 2 * sum(x * log(x / E)) # sum((abs(x - E) - YATES)^2/E) for chisq.test
-    PARAMETER <- (nr - 1L) * (nc - 1L)
-    PVAL <- pchisq(STATISTIC, PARAMETER, lower.tail = FALSE)
-    
-  }
-  else {
-    if (length(dim(x)) > 2L)
-      stop("invalid 'x'")
-    if (length(x) == 1L)
-      stop("'x' must at least have 2 elements")
-    if (length(x) != length(p))
-      stop("'x' and 'p' must have the same number of elements")
-    if (any(p < 0))
-      stop("probabilities must be non-negative.")
-    if (abs(sum(p) - 1) > sqrt(.Machine$double.eps)) {
-      if (rescale.p)
-        p <- p / sum(p)
-      else stop("probabilities must sum to 1.")
-    }
-    METHOD <- "G-test of goodness-of-fit (likelihood ratio test)"
-    E <- n * p
-    V <- n * p * (1 - p)
-    STATISTIC <- 2 * sum(x * log(x / E)) # sum((x - E)^2/E) for chisq.test
-    names(E) <- names(x)
-    
-    PARAMETER <- length(x) - 1
-    PVAL <- pchisq(STATISTIC, PARAMETER, lower.tail = FALSE)
-    
-  }
-  names(STATISTIC) <- "X-squared"
-  names(PARAMETER) <- "df"
-  if (any(E < 5) && is.finite(PARAMETER))
-    warning("G-statistic approximation may be incorrect due to E < 5")
-  
-  structure(list(statistic = STATISTIC, parameter = PARAMETER,
-                 p.value = PVAL, method = METHOD, data.name = DNAME,
-                 observed = x, expected = E, residuals = (x - E) / sqrt(E),
-                 stdres = (x - E) / sqrt(V)), class = "htest")
-}

R/ggplot_rsi.R

@@ -1,425 +0,0 @@
-# ==================================================================== #
-# TITLE                                                                #
-# Antimicrobial Resistance (AMR) Analysis                              #
-#                                                                      #
-# SOURCE                                                               #
-# https://gitlab.com/msberends/AMR                                     #
-#                                                                      #
-# LICENCE                                                              #
-# (c) 2019 Berends MS (m.s.berends@umcg.nl), Luz CF (c.f.luz@umcg.nl)  #
-#                                                                      #
-# This R package is free software; you can freely use and distribute   #
-# it for both personal and commercial purposes under the terms of the  #
-# GNU General Public License version 2.0 (GNU GPL-2), as published by  #
-# the Free Software Foundation.                                        #
-#                                                                      #
-# This R package was created for academic research and was publicly    #
-# released in the hope that it will be useful, but it comes WITHOUT    #
-# ANY WARRANTY OR LIABILITY.                                           #
-# Visit our website for more info: https://msberends.gitlab.io/AMR.    #
-# ==================================================================== #
-
-#' AMR plots with `ggplot2`
-#'
-#' Use these functions to create bar plots for antimicrobial resistance analysis. All functions rely on internal [ggplot2][ggplot2::ggplot()] functions.
-#' @param data a [`data.frame`] with column(s) of class [`rsi`] (see [as.rsi()])
-#' @param position position adjustment of bars, either `"fill"`, `"stack"` or `"dodge"`
-#' @param x variable to show on x axis, either `"antibiotic"` (default) or `"interpretation"` or a grouping variable
-#' @param fill variable to categorise using the plots legend, either `"antibiotic"` (default) or `"interpretation"` or a grouping variable
-#' @param breaks numeric vector of positions
-#' @param limits numeric vector of length two providing limits of the scale, use `NA` to refer to the existing minimum or maximum
-#' @param facet variable to split plots by, either `"interpretation"` (default) or `"antibiotic"` or a grouping variable
-#' @inheritParams proportion
-#' @param nrow (when using `facet`) number of rows
-#' @param colours a named vector with colours for the bars. The names must be one or more of: S, SI, I, IR, R or be `FALSE` to use default [ggplot2][[ggplot2::ggplot()] colours.
-#' @param datalabels show datalabels using [labels_rsi_count()]
-#' @param datalabels.size size of the datalabels
-#' @param datalabels.colour colour of the datalabels
-#' @param title text to show as title of the plot
-#' @param subtitle text to show as subtitle of the plot
-#' @param caption text to show as caption of the plot
-#' @param x.title text to show as x axis description
-#' @param y.title text to show as y axis description
-#' @param ... other parameters passed on to [geom_rsi()]
-#' @details At default, the names of antibiotics will be shown on the plots using [ab_name()]. This can be set with the `translate_ab` parameter. See [count_df()].
-#'
-#' ## The functions
-#' [geom_rsi()] will take any variable from the data that has an [`rsi`] class (created with [as.rsi()]) using [rsi_df()] and will plot bars with the percentage R, I and S. The default behaviour is to have the bars stacked and to have the different antibiotics on the x axis.
-#'
-#' [facet_rsi()] creates 2d plots (at default based on S/I/R) using [ggplot2::facet_wrap()].
-#'
-#' [scale_y_percent()] transforms the y axis to a 0 to 100% range using [ggplot2::scale_continuous()].
-#'
-#' [scale_rsi_colours()] sets colours to the bars: pastel blue for S, pastel turquoise for I and pastel red for R, using [ggplot2::scale_brewer()].
-#'
-#' [theme_rsi()] is a [ggplot2 theme][[ggplot2::theme()] with minimal distraction.
-#'
-#' [labels_rsi_count()] print datalabels on the bars with percentage and amount of isolates using [ggplot2::geom_text()]
-#'
-#' [ggplot_rsi()] is a wrapper around all above functions that uses data as first input. This makes it possible to use this function after a pipe (`%>%`). See Examples.
-#' @rdname ggplot_rsi
-#' @export
-#' @inheritSection AMR Read more on our website!
-#' @examples
-#' library(dplyr)
-#' library(ggplot2)
-#'
-#' # get antimicrobial results for drugs against a UTI:
-#' ggplot(example_isolates %>% select(AMX, NIT, FOS, TMP, CIP)) +
-#'   geom_rsi()
-#'
-#' # prettify the plot using some additional functions:
-#' df <- example_isolates %>% select(AMX, NIT, FOS, TMP, CIP)
-#' ggplot(df) +
-#'   geom_rsi() +
-#'   scale_y_percent() +
-#'   scale_rsi_colours() +
-#'   labels_rsi_count() +
-#'   theme_rsi()
-#'
-#' # or better yet, simplify this using the wrapper function - a single command:
-#' example_isolates %>%
-#'   select(AMX, NIT, FOS, TMP, CIP) %>%
-#'   ggplot_rsi()
-#'
-#' # get only proportions and no counts:
-#' example_isolates %>%
-#'   select(AMX, NIT, FOS, TMP, CIP) %>%
-#'   ggplot_rsi(datalabels = FALSE)
-#'
-#' # add other ggplot2 parameters as you like:
-#' example_isolates %>%
-#'   select(AMX, NIT, FOS, TMP, CIP) %>%
-#'   ggplot_rsi(width = 0.5,
-#'              colour = "black",
-#'              size = 1,
-#'              linetype = 2,
-#'              alpha = 0.25)
-#'
-#' example_isolates %>%
-#'   select(AMX) %>%
-#'   ggplot_rsi(colours = c(SI = "yellow"))
-#'   
-#' \dontrun{
-#' 
-#' # resistance of ciprofloxacine per age group
-#' example_isolates %>%
-#'   mutate(first_isolate = first_isolate(.)) %>%
-#'   filter(first_isolate == TRUE,
-#'          mo == as.mo("E. coli")) %>%
-#'   # `age_group` is also a function of this package:
-#'   group_by(age_group = age_groups(age)) %>%
-#'   select(age_group,
-#'          CIP) %>%
-#'   ggplot_rsi(x = "age_group")
-#'   
-#' # for colourblind mode, use divergent colours from the viridis package:
-#' example_isolates %>%
-#'   select(AMX, NIT, FOS, TMP, CIP) %>%
-#'   ggplot_rsi() + scale_fill_viridis_d()
-#' # a shorter version which also adjusts data label colours:
-#' example_isolates %>%
-#'   select(AMX, NIT, FOS, TMP, CIP) %>%
-#'   ggplot_rsi(colours = FALSE)
-#'
-#'
-#' # it also supports groups (don't forget to use the group var on `x` or `facet`):
-#' example_isolates %>%
-#'   select(hospital_id, AMX, NIT, FOS, TMP, CIP) %>%
-#'   group_by(hospital_id) %>%
-#'   ggplot_rsi(x = "hospital_id",
-#'              facet = "antibiotic",
-#'              nrow = 1,
-#'              title = "AMR of Anti-UTI Drugs Per Hospital",
-#'              x.title = "Hospital",
-#'              datalabels = FALSE)
-#'
-#' # genuine analysis: check 3 most prevalent microorganisms
-#' example_isolates %>%
-#'   # create new bacterial ID's, with all CoNS under the same group (Becker et al.)
-#'   mutate(mo = as.mo(mo, Becker = TRUE)) %>%
-#'   # filter on top three bacterial ID's
-#'   filter(mo %in% top_freq(freq(.$mo), 3)) %>%
-#'   # filter on first isolates
-#'   filter_first_isolate() %>%
-#'   # get short MO names (like "E. coli")
-#'   mutate(bug = mo_shortname(mo, Becker = TRUE)) %>%
-#'   # select this short name and some antiseptic drugs
-#'   select(bug, CXM, GEN, CIP) %>%
-#'   # group by MO
-#'   group_by(bug) %>%
-#'   # plot the thing, putting MOs on the facet
-#'   ggplot_rsi(x = "antibiotic",
-#'              facet = "bug",
-#'              translate_ab = FALSE,
-#'              nrow = 1,
-#'              title = "AMR of Top Three Microorganisms In Blood Culture Isolates",
-#'              subtitle = expression(paste("Only First Isolates, CoNS grouped according to Becker ",
-#'                                          italic("et al."), " (2014)")),
-#'              x.title = "Antibiotic (EARS-Net code)")
-#' }
-ggplot_rsi <- function(data,
-                       position = NULL,
-                       x = "antibiotic",
-                       fill = "interpretation",
-                       # params = list(),
-                       facet = NULL,
-                       breaks = seq(0, 1, 0.1),
-                       limits = NULL,
-                       translate_ab = "name",
-                       combine_SI = TRUE,
-                       combine_IR = FALSE,
-                       language = get_locale(),
-                       nrow = NULL,
-                       colours = c(S = "#61a8ff",
-                                   SI = "#61a8ff",
-                                   I = "#61f7ff",
-                                   IR = "#ff6961",
-                                   R = "#ff6961"),
-                       datalabels = TRUE,
-                       datalabels.size = 2.5,
-                       datalabels.colour = "gray15",
-                       title = NULL,
-                       subtitle = NULL,
-                       caption = NULL,
-                       x.title = "Antimicrobial",
-                       y.title = "Proportion",
-                       ...) {
-
-  stopifnot_installed_package("ggplot2")
-
-  x <- x[1]
-  facet <- facet[1]
-
-  # we work with aes_string later on
-  x_deparse <- deparse(substitute(x))
-  if (x_deparse != "x") {
-    x <- x_deparse
-  }
-  if (x %like% '".*"') {
-    x <- substr(x, 2, nchar(x) - 1)
-  }
-  facet_deparse <- deparse(substitute(facet))
-  if (facet_deparse != "facet") {
-    facet <- facet_deparse
-  }
-  if (facet %like% '".*"') {
-    facet <- substr(facet, 2, nchar(facet) - 1)
-  }
-  if (facet %in% c("NULL", "")) {
-    facet <- NULL
-  }
-
-  if (is.null(position)) {
-    position <- "fill"
-  }
-
-  p <- ggplot2::ggplot(data = data) +
-    geom_rsi(position = position, x = x, fill = fill, translate_ab = translate_ab,
-             combine_SI = combine_SI, combine_IR = combine_IR, ...) +
-    theme_rsi()
-
-  if (fill == "interpretation") {
-    # set RSI colours
-    if (isFALSE(colours) & missing(datalabels.colour)) {
-      # set datalabel colour to middle gray
-      datalabels.colour <- "gray50"
-    }
-    p <- p + scale_rsi_colours(colours = colours)
-  }
-
-  if (identical(position, "fill")) {
-    # proportions, so use y scale with percentage
-    p <- p + scale_y_percent(breaks = breaks, limits = limits)
-  }
-
-  if (datalabels == TRUE) {
-    p <- p + labels_rsi_count(position = position,
-                              x = x,
-                              translate_ab = translate_ab,
-                              combine_SI = combine_SI,
-                              combine_IR = combine_IR,
-                              datalabels.size = datalabels.size,
-                              datalabels.colour = datalabels.colour)
-  }
-
-  if (!is.null(facet)) {
-    p <- p + facet_rsi(facet = facet, nrow = nrow)
-  }
-
-  p <- p + ggplot2::labs(title = title,
-                         subtitle = subtitle,
-                         caption = caption,
-                         x = x.title,
-                         y = y.title)
-
-  p
-}
-
-#' @rdname ggplot_rsi
-#' @export
-geom_rsi <- function(position = NULL,
-                     x = c("antibiotic", "interpretation"),
-                     fill = "interpretation",
-                     translate_ab = "name",
-                     language = get_locale(),
-                     combine_SI = TRUE,
-                     combine_IR = FALSE,
-                     ...)  {
-
-  stopifnot_installed_package("ggplot2")
-
-  if (is.data.frame(position)) {
-    stop("`position` is invalid. Did you accidentally use '%>%' instead of '+'?", call. = FALSE)
-  }
-
-  y <- "value"
-  if (missing(position) | is.null(position)) {
-    position <- "fill"
-  }
-
-  if (identical(position, "fill")) {
-    position <- ggplot2::position_fill(vjust = 0.5, reverse = TRUE)
-  }
-
-  x <- x[1]
-
-  # we work with aes_string later on
-  x_deparse <- deparse(substitute(x))
-  if (x_deparse != "x") {
-    x <- x_deparse
-  }
-  if (x %like% '".*"') {
-    x <- substr(x, 2, nchar(x) - 1)
-  }
-
-  if (tolower(x) %in% tolower(c("ab", "abx", "antibiotics"))) {
-    x <- "antibiotic"
-  } else if (tolower(x) %in% tolower(c("SIR", "RSI", "interpretations", "result"))) {
-    x <- "interpretation"
-  }
-
-  ggplot2::layer(geom = "bar", stat = "identity", position = position,
-                 mapping = ggplot2::aes_string(x = x, y = y, fill = fill),
-                 params = list(...), data = function(x) {
-                   AMR::rsi_df(data = x,
-                               translate_ab = translate_ab,
-                               language = language,
-                               combine_SI = combine_SI,
-                               combine_IR = combine_IR)
-                 })
-
-}
-
-#' @rdname ggplot_rsi
-#' @export
-facet_rsi <- function(facet = c("interpretation", "antibiotic"), nrow = NULL) {
-
-  stopifnot_installed_package("ggplot2")
-
-  facet <- facet[1]
-
-  # we work with aes_string later on
-  facet_deparse <- deparse(substitute(facet))
-  if (facet_deparse != "facet") {
-    facet <- facet_deparse
-  }
-  if (facet %like% '".*"') {
-    facet <- substr(facet, 2, nchar(facet) - 1)
-  }
-
-  if (tolower(facet) %in% tolower(c("SIR", "RSI", "interpretations", "result"))) {
-    facet <- "interpretation"
-  } else if (tolower(facet) %in% tolower(c("ab", "abx", "antibiotics"))) {
-    facet <- "antibiotic"
-  }
-
-  ggplot2::facet_wrap(facets = facet, scales = "free_x", nrow = nrow)
-}
-
-#' @rdname ggplot_rsi
-#' @importFrom cleaner percentage
-#' @export
-scale_y_percent <- function(breaks = seq(0, 1, 0.1), limits = NULL) {
-  stopifnot_installed_package("ggplot2")
-
-  if (all(breaks[breaks != 0] > 1)) {
-    breaks <- breaks / 100
-  }
-  ggplot2::scale_y_continuous(breaks = breaks,
-                              labels = percentage(breaks),
-                              limits = limits)
-}
-
-#' @rdname ggplot_rsi
-#' @export
-scale_rsi_colours <- function(colours = c(S = "#61a8ff",
-                                          SI = "#61a8ff",
-                                          I = "#61f7ff",
-                                          IR = "#ff6961",
-                                          R = "#ff6961")) {
-  stopifnot_installed_package("ggplot2")
-  # previous colour: palette = "RdYlGn"
-  # previous colours: values = c("#b22222", "#ae9c20", "#7cfc00")
-
-  if (!identical(colours, FALSE)) {
-    original_cols <- c(S = "#61a8ff",
-                       SI = "#61a8ff",
-                       I = "#61f7ff",
-                       IR = "#ff6961",
-                       R = "#ff6961")
-    colours <- replace(original_cols, names(colours), colours)
-    ggplot2::scale_fill_manual(values = colours)
-  }
-}
-
-#' @rdname ggplot_rsi
-#' @export
-theme_rsi <- function() {
-  stopifnot_installed_package("ggplot2")
-  ggplot2::theme_minimal(base_size = 10) +
-    ggplot2::theme(panel.grid.major.x = ggplot2::element_blank(),
-                   panel.grid.minor = ggplot2::element_blank(),
-                   panel.grid.major.y = ggplot2::element_line(colour = "grey75"),
-                   # center title and subtitle
-                   plot.title = ggplot2::element_text(hjust = 0.5),
-                   plot.subtitle = ggplot2::element_text(hjust = 0.5))
-}
-
-#' @rdname ggplot_rsi
-#' @importFrom dplyr mutate %>% group_by_at
-#' @importFrom cleaner percentage
-#' @export
-labels_rsi_count <- function(position = NULL,
-                             x = "antibiotic",
-                             translate_ab = "name",
-                             combine_SI = TRUE,
-                             combine_IR = FALSE,
-                             datalabels.size = 3,
-                             datalabels.colour = "gray15") {
-  stopifnot_installed_package("ggplot2")
-  if (is.null(position)) {
-    position <- "fill"
-  }
-  if (identical(position, "fill")) {
-    position <- ggplot2::position_fill(vjust = 0.5, reverse = TRUE)
-  }
-  x_name <- x
-  ggplot2::geom_text(mapping = ggplot2::aes_string(label = "lbl",
-                                                   x = x,
-                                                   y = "value"),
-                     position = position,
-                     inherit.aes = FALSE,
-                     size = datalabels.size,
-                     colour = datalabels.colour,
-                     lineheight = 0.75,
-                     data = function(x) {
-                       rsi_df(data = x,
-                              translate_ab = translate_ab,
-                              combine_SI = combine_SI,
-                              combine_IR = combine_IR) %>%
-                         group_by_at(x_name) %>%
-                         mutate(lbl = paste0(percentage(value / sum(value, na.rm = TRUE)),
-                                             "\n(n=", isolates, ")"))
-                     })
-}

R/globals.R

@@ -1,102 +0,0 @@
-# ==================================================================== #
-# TITLE                                                                #
-# Antimicrobial Resistance (AMR) Analysis                              #
-#                                                                      #
-# SOURCE                                                               #
-# https://gitlab.com/msberends/AMR                                     #
-#                                                                      #
-# LICENCE                                                              #
-# (c) 2019 Berends MS (m.s.berends@umcg.nl), Luz CF (c.f.luz@umcg.nl)  #
-#                                                                      #
-# This R package is free software; you can freely use and distribute   #
-# it for both personal and commercial purposes under the terms of the  #
-# GNU General Public License version 2.0 (GNU GPL-2), as published by  #
-# the Free Software Foundation.                                        #
-#                                                                      #
-# This R package was created for academic research and was publicly    #
-# released in the hope that it will be useful, but it comes WITHOUT    #
-# ANY WARRANTY OR LIABILITY.                                           #
-# Visit our website for more info: https://msberends.gitlab.io/AMR.    #
-# ==================================================================== #
-
-globalVariables(c(".",
-                  "..property",
-                  "ab",
-                  "ab_txt",
-                  "abbreviations",
-                  "antibiotic",
-                  "CNS_CPS",
-                  "col_id",
-                  "count",
-                  "count.x",
-                  "date_lab",
-                  "diff.percent",
-                  "First name",
-                  "first_isolate_row_index",
-                  "fullname",
-                  "fullname_lower",
-                  "genus",
-                  "gramstain",
-                  "group",
-                  "index",
-                  "input",
-                  "interpretation",
-                  "isolates",
-                  "item",
-                  "key_ab",
-                  "key_ab_lag",
-                  "key_ab_other",
-                  "kingdom",
-                  "kingdom_index",
-                  "lang",
-                  "Last name",
-                  "lookup",
-                  "mdr",
-                  "MDRO",
-                  "median",
-                  "microorganisms",
-                  "microorganisms.codes",
-                  "missing_names",
-                  "mo",
-                  "mono_count",
-                  "more_than_episode_ago",
-                  "name",
-                  "new",
-                  "newvar_date",
-                  "newvar_genus_species",
-                  "newvar_mo",
-                  "newvar_patient_id",
-                  "newvar_row_index",
-                  "newvar_row_index_sorted",
-                  "observations",
-                  "observed",
-                  "old",
-                  "old_name",
-                  "other_pat_or_mo",
-                  "package_version",
-                  "patient_id",
-                  "pattern",
-                  "plural",
-                  "prevalence",
-                  "R",
-                  "real_first_isolate",
-                  "ref",
-                  "rule_group",
-                  "rule_name",
-                  "S",
-                  "se_max",
-                  "se_min",
-                  "second",
-                  "Sex",
-                  "species",
-                  "species_id",
-                  "subspecies",
-                  "synonyms",
-                  "total",
-                  "txt",
-                  "uncertainty_level",
-                  "value",
-                  "x",
-                  "xdr",
-                  "y",
-                  "year"))

R/guess_ab_col.R

@@ -1,230 +0,0 @@
-# ==================================================================== #
-# TITLE                                                                #
-# Antimicrobial Resistance (AMR) Analysis                              #
-#                                                                      #
-# SOURCE                                                               #
-# https://gitlab.com/msberends/AMR                                     #
-#                                                                      #
-# LICENCE                                                              #
-# (c) 2019 Berends MS (m.s.berends@umcg.nl), Luz CF (c.f.luz@umcg.nl)  #
-#                                                                      #
-# This R package is free software; you can freely use and distribute   #
-# it for both personal and commercial purposes under the terms of the  #
-# GNU General Public License version 2.0 (GNU GPL-2), as published by  #
-# the Free Software Foundation.                                        #
-#                                                                      #
-# This R package was created for academic research and was publicly    #
-# released in the hope that it will be useful, but it comes WITHOUT    #
-# ANY WARRANTY OR LIABILITY.                                           #
-# Visit our website for more info: https://msberends.gitlab.io/AMR.    #
-# ==================================================================== #
-
-#' Guess antibiotic column
-#'
-#' This tries to find a column name in a data set based on information from the [antibiotics] data set. Also supports WHONET abbreviations.
-#' @param x a [`data.frame`]
-#' @param search_string a text to search `x` for, will be checked with [as.ab()] if this value is not a column in `x`
-#' @param verbose a logical to indicate whether additional info should be printed
-#' @details You can look for an antibiotic (trade) name or abbreviation and it will search `x` and the [antibiotics] data set for any column containing a name or code of that antibiotic. **Longer columns names take precendence over shorter column names.**
-#' @importFrom dplyr %>% select filter_all any_vars
-#' @importFrom crayon blue
-#' @return A column name of `x`, or `NULL` when no result is found.
-#' @export
-#' @inheritSection AMR Read more on our website!
-#' @examples
-#' df <- data.frame(amox = "S",
-#'                  tetr = "R")
-#'
-#' guess_ab_col(df, "amoxicillin")
-#' # [1] "amox"
-#' guess_ab_col(df, "J01AA07") # ATC code of tetracycline
-#' # [1] "tetr"
-#'
-#' guess_ab_col(df, "J01AA07", verbose = TRUE)
-#' # Note: Using column `tetr` as input for "J01AA07".
-#' # [1] "tetr"
-#'
-#' # WHONET codes
-#' df <- data.frame(AMP_ND10 = "R",
-#'                  AMC_ED20 = "S")
-#' guess_ab_col(df, "ampicillin")
-#' # [1] "AMP_ND10"
-#' guess_ab_col(df, "J01CR02")
-#' # [1] "AMC_ED20"
-#' guess_ab_col(df, as.ab("augmentin"))
-#' # [1] "AMC_ED20"
-#'
-#' # Longer names take precendence:
-#' df <- data.frame(AMP_ED2 = "S",
-#'                  AMP_ED20 = "S")
-#' guess_ab_col(df, "ampicillin")
-#' # [1] "AMP_ED20"
-guess_ab_col <- function(x = NULL, search_string = NULL, verbose = FALSE) {
-  if (is.null(x) & is.null(search_string)) {
-    return(as.name("guess_ab_col"))
-  }
-  if (!is.data.frame(x)) {
-    stop("`x` must be a data.frame")
-  }
-
-  if (length(search_string) > 1) {
-    warning("argument 'search_string' has length > 1 and only the first element will be used")
-    search_string <- search_string[1]
-  }
-  search_string <- as.character(search_string)
-
-  if (search_string %in% colnames(x)) {
-    ab_result <- search_string
-  } else {
-    search_string.ab <- suppressWarnings(as.ab(search_string))
-    if (search_string.ab %in% colnames(x)) {
-      ab_result <- colnames(x)[colnames(x) == search_string.ab][1L]
-
-    } else if (any(tolower(colnames(x)) %in% tolower(unlist(ab_property(search_string.ab, "abbreviations"))))) {
-      ab_result <- colnames(x)[tolower(colnames(x)) %in% tolower(unlist(ab_property(search_string.ab, "abbreviations")))][1L]
-
-    } else {
-      # sort colnames on length - longest first
-      cols <- colnames(x[, x %>% colnames() %>% nchar() %>% order() %>% rev()])
-      df_trans <- data.frame(cols = cols,
-                             abs = suppressWarnings(as.ab(cols)),
-                             stringsAsFactors = FALSE)
-      ab_result <- df_trans[which(df_trans$abs == search_string.ab), "cols"]
-      ab_result <- ab_result[!is.na(ab_result)][1L]
-    }
-  }
-
-  if (length(ab_result) == 0) {
-    if (verbose == TRUE) {
-      message(paste0("No column found as input for `", search_string,
-                     "` (", ab_name(search_string, language = "en", tolower = TRUE), ")."))
-    }
-    return(NULL)
-  } else {
-    if (verbose == TRUE) {
-      message(blue(paste0("NOTE: Using column `", bold(ab_result), "` as input for `", search_string,
-                          "` (", ab_name(search_string, language = "en", tolower = TRUE), ").")))
-    }
-    return(ab_result)
-  }
-}
-
-
-#' @importFrom crayon blue bold
-#' @importFrom dplyr %>% mutate arrange pull
-get_column_abx <- function(x,
-                           soft_dependencies = NULL,
-                           hard_dependencies = NULL,
-                           verbose = FALSE,
-                           ...) {
-
-  message(blue("NOTE: Auto-guessing columns suitable for analysis..."), appendLF = FALSE)
-  
-  x <- as.data.frame(x, stringsAsFactors = FALSE)
-  x_bak <- x
-  # only check columns that are a valid AB code, ATC code, name, abbreviation or synonym,
-  # or already have the rsi class (as.rsi) 
-  # and that have no more than 50% invalid values
-  vectr_antibiotics <- unique(toupper(unlist(AMR::antibiotics[, c("ab", "atc", "name", "abbreviations", "synonyms")])))
-  vectr_antibiotics <- vectr_antibiotics[!is.na(vectr_antibiotics) & nchar(vectr_antibiotics) >= 3]
-  x_columns <- sapply(colnames(x), function(col, df = x_bak) {
-    if (toupper(col) %in% vectr_antibiotics | 
-        is.rsi(as.data.frame(df)[, col]) |
-        is.rsi.eligible(as.data.frame(df)[, col], threshold = 0.5)) {
-      return(col)
-    } else {
-      return(NA_character_)
-    }
-  })
-  x_columns <- x_columns[!is.na(x_columns)]
-  x <- x[, x_columns, drop = FALSE] # without drop = TRUE, x will become a vector when x_columns is length 1
-
-  df_trans <- data.frame(colnames = colnames(x),
-                         abcode = suppressWarnings(as.ab(colnames(x))))
-  df_trans <- df_trans[!is.na(df_trans$abcode), ]
-  x <- as.character(df_trans$colnames)
-  names(x) <- df_trans$abcode
-
-  # add from self-defined dots (...):
-  # such as get_column_abx(example_isolates %>% rename(thisone = AMX), amox = "thisone")
-  dots <- list(...)
-  if (length(dots) > 0) {
-    newnames <- suppressWarnings(as.ab(names(dots)))
-    if (any(is.na(newnames))) {
-      warning("Invalid antibiotic reference(s): ", toString(names(dots)[is.na(newnames)]),
-              call. = FALSE, immediate. = TRUE)
-    }
-    # turn all NULLs to NAs
-    dots <- unlist(lapply(dots, function(x) if (is.null(x)) NA else x))
-    names(dots) <- newnames
-    dots <- dots[!is.na(names(dots))]
-    # merge, but overwrite automatically determined ones by 'dots'
-    x <- c(x[!x %in% dots & !names(x) %in% names(dots)], dots)
-    # delete NAs, this will make e.g. eucast_rules(... TMP = NULL) work to prevent TMP from being used
-    x <- x[!is.na(x)]
-  }
-
-  # sort on name
-  x <- x[order(names(x), x)]
-  duplicates <- c(x[base::duplicated(x)], x[base::duplicated(names(x))]) 
-  duplicates <- duplicates[unique(names(duplicates))]
-  x <- c(x[!names(x) %in% names(duplicates)], duplicates)
-  x <- x[order(names(x), x)]
-  
-  # succeeded with aut-guessing
-  message(blue("OK."))
-
-  for (i in seq_len(length(x))) {
-    if (verbose == TRUE & !names(x[i]) %in% names(duplicates)) {
-      message(blue(paste0("NOTE: Using column `", bold(x[i]), "` as input for `", names(x)[i],
-                          "` (", ab_name(names(x)[i], tolower = TRUE), ").")))
-    }
-    if (names(x[i]) %in% names(duplicates)) {
-      warning(red(paste0("Using column `", bold(x[i]), "` as input for `", names(x)[i],
-                         "` (", ab_name(names(x)[i], tolower = TRUE),
-                         "), although it was matched for multiple antibiotics or columns.")), 
-              call. = FALSE, 
-              immediate. = verbose)
-    }
-  }
-  
-  
-  if (!is.null(hard_dependencies)) {
-    hard_dependencies <- unique(hard_dependencies)
-    if (!all(hard_dependencies %in% names(x))) {
-      # missing a hard dependency will return NA and consequently the data will not be analysed
-      missing <- hard_dependencies[!hard_dependencies %in% names(x)]
-      generate_warning_abs_missing(missing, any = FALSE)
-      return(NA)
-    }
-  }
-  if (!is.null(soft_dependencies)) {
-    soft_dependencies <- unique(soft_dependencies)
-    if (!all(soft_dependencies %in% names(x))) {
-      # missing a soft dependency may lower the reliability
-      missing <- soft_dependencies[!soft_dependencies %in% names(x)]
-      missing_txt <- data.frame(missing = missing,
-                                missing_names = AMR::ab_name(missing, tolower = TRUE),
-                                stringsAsFactors = FALSE) %>%
-        mutate(txt = paste0(bold(missing), " (", missing_names, ")")) %>%
-        arrange(missing_names) %>%
-        pull(txt)
-      message(blue("NOTE: Reliability will be improved if these antimicrobial results would be available too:",
-                   paste(missing_txt, collapse = ", ")))
-    }
-  }
-  x
-}
-
-generate_warning_abs_missing <- function(missing, any = FALSE) {
-  missing <- paste0(missing, " (", ab_name(missing, tolower = TRUE), ")")
-  if (any == TRUE) {
-    any_txt <- c(" any of", "is")
-  } else {
-    any_txt <- c("", "are")
-  }
-  warning(paste0("Introducing NAs since", any_txt[1], " these antimicrobials ", any_txt[2], " required: ",
-                 paste(missing, collapse = ", ")),
-          immediate. = TRUE,
-          call. = FALSE)
-}

R/join_microorganisms.R

@@ -1,158 +0,0 @@
-# ==================================================================== #
-# TITLE                                                                #
-# Antimicrobial Resistance (AMR) Analysis                              #
-#                                                                      #
-# SOURCE                                                               #
-# https://gitlab.com/msberends/AMR                                     #
-#                                                                      #
-# LICENCE                                                              #
-# (c) 2019 Berends MS (m.s.berends@umcg.nl), Luz CF (c.f.luz@umcg.nl)  #
-#                                                                      #
-# This R package is free software; you can freely use and distribute   #
-# it for both personal and commercial purposes under the terms of the  #
-# GNU General Public License version 2.0 (GNU GPL-2), as published by  #
-# the Free Software Foundation.                                        #
-#                                                                      #
-# This R package was created for academic research and was publicly    #
-# released in the hope that it will be useful, but it comes WITHOUT    #
-# ANY WARRANTY OR LIABILITY.                                           #
-# Visit our website for more info: https://msberends.gitlab.io/AMR.    #
-# ==================================================================== #
-
-#' Join a table with [microorganisms]
-#'
-#' Join the data set [microorganisms] easily to an existing table or character vector.
-#' @rdname join
-#' @name join
-#' @aliases join inner_join
-#' @param x existing table to join, or character vector
-#' @param by a variable to join by - if left empty will search for a column with class [`mo`] (created with [as.mo()]) or will be `"mo"` if that column name exists in `x`, could otherwise be a column name of `x` with values that exist in `microorganisms$mo` (like `by = "bacteria_id"`), or another column in [microorganisms] (but then it should be named, like `by = c("my_genus_species" = "fullname")`)
-#' @param suffix if there are non-joined duplicate variables in `x` and `y`, these suffixes will be added to the output to disambiguate them. Should be a character vector of length 2.
-#' @param ... other parameters to pass on to [dplyr::join()]
-#' @details **Note:** As opposed to the [dplyr::join()] functions of `dplyr`, [`character`] vectors are supported and at default existing columns will get a suffix `"2"` and the newly joined columns will not get a suffix. See [dplyr::join()] for more information.
-#' @inheritSection AMR Read more on our website!
-#' @export
-#' @examples
-#' left_join_microorganisms(as.mo("K. pneumoniae"))
-#' left_join_microorganisms("B_KLBSL_PNE")
-#'
-#' library(dplyr)
-#' example_isolates %>% left_join_microorganisms()
-#'
-#' df <- data.frame(date = seq(from = as.Date("2018-01-01"),
-#'                             to = as.Date("2018-01-07"),
-#'                             by = 1),
-#'                  bacteria = as.mo(c("S. aureus", "MRSA", "MSSA", "STAAUR",
-#'                                     "E. coli", "E. coli", "E. coli")),
-#'                  stringsAsFactors = FALSE)
-#' colnames(df)
-#' df_joined <- left_join_microorganisms(df, "bacteria")
-#' colnames(df_joined)
-inner_join_microorganisms <- function(x, by = NULL, suffix = c("2", ""), ...) {
-  checked <- joins_check_df(x, by)
-  x <- checked$x
-  by <- checked$by
-  join <- suppressWarnings(
-    dplyr::inner_join(x = x, y = AMR::microorganisms, by = by, suffix = suffix, ...)
-  )
-  if (nrow(join) > nrow(x)) {
-    warning("The newly joined tbl contains ", nrow(join) - nrow(x), " rows more that its original.")
-  }
-  join
-}
-
-#' @rdname join
-#' @export
-left_join_microorganisms <- function(x, by = NULL, suffix = c("2", ""), ...) {
-  checked <- joins_check_df(x, by)
-  x <- checked$x
-  by <- checked$by
-  join <- suppressWarnings(
-    dplyr::left_join(x = x, y = AMR::microorganisms, by = by, suffix = suffix, ...)
-  )
-  if (nrow(join) > nrow(x)) {
-    warning("The newly joined tbl contains ", nrow(join) - nrow(x), " rows more that its original.")
-  }
-  join
-}
-
-#' @rdname join
-#' @export
-right_join_microorganisms <- function(x, by = NULL, suffix = c("2", ""), ...) {
-  checked <- joins_check_df(x, by)
-  x <- checked$x
-  by <- checked$by
-  join <- suppressWarnings(
-    dplyr::right_join(x = x, y = AMR::microorganisms, by = by, suffix = suffix, ...)
-  )
-  if (nrow(join) > nrow(x)) {
-    warning("The newly joined tbl contains ", nrow(join) - nrow(x), " rows more that its original.")
-  }
-  join
-}
-
-#' @rdname join
-#' @export
-full_join_microorganisms <- function(x, by = NULL, suffix = c("2", ""), ...) {
-  checked <- joins_check_df(x, by)
-  x <- checked$x
-  by <- checked$by
-  join <- suppressWarnings(
-    dplyr::full_join(x = x, y = AMR::microorganisms, by = by, suffix = suffix, ...)
-  )
-  if (nrow(join) > nrow(x)) {
-    warning("The newly joined tbl contains ", nrow(join) - nrow(x), " rows more that its original.")
-  }
-  join
-}
-
-#' @rdname join
-#' @export
-semi_join_microorganisms <- function(x, by = NULL, ...) {
-  checked <- joins_check_df(x, by)
-  x <- checked$x
-  by <- checked$by
-  suppressWarnings(
-    dplyr::semi_join(x = x, y = AMR::microorganisms, by = by, ...)
-  )
-}
-
-#' @rdname join
-#' @export
-anti_join_microorganisms <- function(x, by = NULL, ...) {
-  checked <- joins_check_df(x, by)
-  x <- checked$x
-  by <- checked$by
-  suppressWarnings(
-    dplyr::anti_join(x = x, y = AMR::microorganisms, by = by, ...)
-  )
-}
-
-joins_check_df <- function(x, by) {
-  if (!any(class(x) %in% c("data.frame", "matrix"))) {
-    x <- data.frame(mo = as.character(x), stringsAsFactors = FALSE)
-    if (is.null(by)) {
-      by <- "mo"
-    }
-  }
-  if (is.null(by)) {
-    # search for column with class `mo` and return first one found
-    by <- colnames(x)[lapply(x, is.mo) == TRUE][1]
-    if (is.na(by)) {
-      if ("mo" %in% colnames(x)) {
-        by <- "mo"
-      } else {
-        stop("Cannot join - no column found with name or class  `mo`.", call. = FALSE)
-      }
-    }
-    message('Joining, by = "', by, '"') # message same as dplyr::join functions
-  }
-  if (is.null(names(by))) {
-    joinby <- colnames(AMR::microorganisms)[1]
-    names(joinby) <- by
-  } else {
-    joinby <- by
-  }
-  list(x = x,
-       by = joinby)
-}

R/key_antibiotics.R

@@ -1,335 +0,0 @@
-# ==================================================================== #
-# TITLE                                                                #
-# Antimicrobial Resistance (AMR) Analysis                              #
-#                                                                      #
-# SOURCE                                                               #
-# https://gitlab.com/msberends/AMR                                     #
-#                                                                      #
-# LICENCE                                                              #
-# (c) 2019 Berends MS (m.s.berends@umcg.nl), Luz CF (c.f.luz@umcg.nl)  #
-#                                                                      #
-# This R package is free software; you can freely use and distribute   #
-# it for both personal and commercial purposes under the terms of the  #
-# GNU General Public License version 2.0 (GNU GPL-2), as published by  #
-# the Free Software Foundation.                                        #
-#                                                                      #
-# This R package was created for academic research and was publicly    #
-# released in the hope that it will be useful, but it comes WITHOUT    #
-# ANY WARRANTY OR LIABILITY.                                           #
-# Visit our website for more info: https://msberends.gitlab.io/AMR.    #
-# ==================================================================== #
-
-#' Key antibiotics for first *weighted* isolates
-#'
-#' These function can be used to determine first isolates (see [first_isolate()]). Using key antibiotics to determine first isolates is more reliable than without key antibiotics. These selected isolates will then be called first *weighted* isolates.
-#' @param x table with antibiotics coloms, like `AMX` or `amox`
-#' @param y,z characters to compare
-#' @inheritParams first_isolate
-#' @param universal_1,universal_2,universal_3,universal_4,universal_5,universal_6 column names of **broad-spectrum** antibiotics, case-insensitive. At default, the columns containing these antibiotics will be guessed with [guess_ab_col()].
-#' @param GramPos_1,GramPos_2,GramPos_3,GramPos_4,GramPos_5,GramPos_6 column names of antibiotics for **Gram-positives**, case-insensitive. At default, the columns containing these antibiotics will be guessed with [guess_ab_col()].
-#' @param GramNeg_1,GramNeg_2,GramNeg_3,GramNeg_4,GramNeg_5,GramNeg_6 column names of antibiotics for **Gram-negatives**, case-insensitive. At default, the columns containing these antibiotics will be guessed with [guess_ab_col()].
-#' @param warnings give warning about missing antibiotic columns, they will anyway be ignored
-#' @param ... other parameters passed on to function
-#' @details The function [key_antibiotics()] returns a character vector with 12 antibiotic results for every isolate. These isolates can then be compared using [key_antibiotics_equal()], to check if two isolates have generally the same antibiogram. Missing and invalid values are replaced with a dot (`"."`). The [first_isolate()] function only uses this function on the same microbial species from the same patient. Using this, an MRSA will be included after a susceptible *S. aureus* (MSSA) found within the same episode (see `episode` parameter of [first_isolate()]). Without key antibiotic comparison it would not.
-#'
-#' At default, the antibiotics that are used for **Gram-positive bacteria** are:
-#' - Amoxicillin
-#' - Amoxicillin/clavulanic acid
-#' - Cefuroxime
-#' - Piperacillin/tazobactam
-#' - Ciprofloxacin
-#' - Trimethoprim/sulfamethoxazole
-#' - Vancomycin
-#' - Teicoplanin
-#' - Tetracycline
-#' - Erythromycin
-#' - Oxacillin
-#' - Rifampin
-#'
-#' At default the antibiotics that are used for **Gram-negative bacteria** are:
-#' - Amoxicillin
-#' - Amoxicillin/clavulanic acid
-#' - Cefuroxime
-#' - Piperacillin/tazobactam
-#' - Ciprofloxacin
-#' - Trimethoprim/sulfamethoxazole
-#' - Gentamicin
-#' - Tobramycin
-#' - Colistin
-#' - Cefotaxime
-#' - Ceftazidime
-#' - Meropenem
-#' 
-#' The function [key_antibiotics_equal()] checks the characters returned by [key_antibiotics()] for equality, and returns a [`logical`] vector.
-#' @inheritSection first_isolate Key antibiotics
-#' @rdname key_antibiotics
-#' @export
-#' @importFrom dplyr %>% mutate if_else pull
-#' @importFrom crayon blue bold
-#' @seealso [first_isolate()]
-#' @inheritSection AMR Read more on our website!
-#' @examples
-#' # `example_isolates` is a dataset available in the AMR package.
-#' # See ?example_isolates.
-#'
-#' library(dplyr)
-#' # set key antibiotics to a new variable
-#' my_patients <- example_isolates %>%
-#'   mutate(keyab = key_antibiotics(.)) %>%
-#'   mutate(
-#'     # now calculate first isolates
-#'     first_regular = first_isolate(., col_keyantibiotics = FALSE),
-#'     # and first WEIGHTED isolates
-#'     first_weighted = first_isolate(., col_keyantibiotics = "keyab")
-#'   )
-#'
-#' # Check the difference, in this data set it results in 7% more isolates:
-#' sum(my_patients$first_regular, na.rm = TRUE)
-#' sum(my_patients$first_weighted, na.rm = TRUE)
-#'
-#'
-#' # output of the `key_antibiotics` function could be like this:
-#' strainA <- "SSSRR.S.R..S"
-#' strainB <- "SSSIRSSSRSSS"
-#'
-#' key_antibiotics_equal(strainA, strainB)
-#' # TRUE, because I is ignored (as well as missing values)
-#'
-#' key_antibiotics_equal(strainA, strainB, ignore_I = FALSE)
-#' # FALSE, because I is not ignored and so the 4th value differs
-key_antibiotics <- function(x,
-                            col_mo = NULL,
-                            universal_1 = guess_ab_col(x, "amoxicillin"),
-                            universal_2 = guess_ab_col(x, "amoxicillin/clavulanic acid"),
-                            universal_3 = guess_ab_col(x, "cefuroxime"),
-                            universal_4 = guess_ab_col(x, "piperacillin/tazobactam"),
-                            universal_5 = guess_ab_col(x, "ciprofloxacin"),
-                            universal_6 = guess_ab_col(x, "trimethoprim/sulfamethoxazole"),
-                            GramPos_1 = guess_ab_col(x, "vancomycin"),
-                            GramPos_2 = guess_ab_col(x, "teicoplanin"),
-                            GramPos_3 = guess_ab_col(x, "tetracycline"),
-                            GramPos_4 = guess_ab_col(x, "erythromycin"),
-                            GramPos_5 = guess_ab_col(x, "oxacillin"),
-                            GramPos_6 = guess_ab_col(x, "rifampin"),
-                            GramNeg_1 = guess_ab_col(x, "gentamicin"),
-                            GramNeg_2 = guess_ab_col(x, "tobramycin"),
-                            GramNeg_3 = guess_ab_col(x, "colistin"),
-                            GramNeg_4 = guess_ab_col(x, "cefotaxime"),
-                            GramNeg_5 = guess_ab_col(x, "ceftazidime"),
-                            GramNeg_6 = guess_ab_col(x, "meropenem"),
-                            warnings = TRUE,
-                            ...) {
-
-  # try to find columns based on type
-  # -- mo
-  if (is.null(col_mo)) {
-    col_mo <- search_type_in_df(x = x, type = "mo")
-  }
-  if (is.null(col_mo)) {
-    stop("`col_mo` must be set.", call. = FALSE)
-  }
-
-  # check columns
-  col.list <- c(universal_1, universal_2, universal_3, universal_4, universal_5, universal_6,
-                GramPos_1, GramPos_2, GramPos_3, GramPos_4, GramPos_5, GramPos_6,
-                GramNeg_1, GramNeg_2, GramNeg_3, GramNeg_4, GramNeg_5, GramNeg_6)
-  check_available_columns <- function(x, col.list, info = TRUE) {
-    # check columns
-    col.list <- col.list[!is.na(col.list) & !is.null(col.list)]
-    names(col.list) <- col.list
-    col.list.bak <- col.list
-    # are they available as upper case or lower case then?
-    for (i in seq_len(length(col.list))) {
-      if (is.null(col.list[i]) | isTRUE(is.na(col.list[i]))) {
-        col.list[i] <- NA
-      } else if (toupper(col.list[i]) %in% colnames(x)) {
-        col.list[i] <- toupper(col.list[i])
-      } else if (tolower(col.list[i]) %in% colnames(x)) {
-        col.list[i] <- tolower(col.list[i])
-      } else if (!col.list[i] %in% colnames(x)) {
-        col.list[i] <- NA
-      }
-    }
-    if (!all(col.list %in% colnames(x))) {
-      if (info == TRUE) {
-        warning("Some columns do not exist and will be ignored: ",
-                col.list.bak[!(col.list %in% colnames(x))] %>% toString(),
-                ".\nTHIS MAY STRONGLY INFLUENCE THE OUTCOME.",
-                immediate. = TRUE,
-                call. = FALSE)
-      }
-    }
-    col.list
-  }
-
-  col.list <- check_available_columns(x = x, col.list = col.list, info = warnings)
-  universal_1 <- col.list[universal_1]
-  universal_2 <- col.list[universal_2]
-  universal_3 <- col.list[universal_3]
-  universal_4 <- col.list[universal_4]
-  universal_5 <- col.list[universal_5]
-  universal_6 <- col.list[universal_6]
-  GramPos_1 <- col.list[GramPos_1]
-  GramPos_2 <- col.list[GramPos_2]
-  GramPos_3 <- col.list[GramPos_3]
-  GramPos_4 <- col.list[GramPos_4]
-  GramPos_5 <- col.list[GramPos_5]
-  GramPos_6 <- col.list[GramPos_6]
-  GramNeg_1 <- col.list[GramNeg_1]
-  GramNeg_2 <- col.list[GramNeg_2]
-  GramNeg_3 <- col.list[GramNeg_3]
-  GramNeg_4 <- col.list[GramNeg_4]
-  GramNeg_5 <- col.list[GramNeg_5]
-  GramNeg_6 <- col.list[GramNeg_6]
-
-  universal <- c(universal_1, universal_2, universal_3,
-                 universal_4, universal_5, universal_6)
-
-  gram_positive <- c(universal,
-                    GramPos_1, GramPos_2, GramPos_3,
-                    GramPos_4, GramPos_5, GramPos_6)
-  gram_positive <- gram_positive[!is.null(gram_positive)]
-  gram_positive <- gram_positive[!is.na(gram_positive)]
-  if (length(gram_positive) < 12) {
-    warning("only using ", length(gram_positive), " different antibiotics as key antibiotics for Gram-positives. See ?key_antibiotics.", call. = FALSE)
-  }
-
-  gram_negative <- c(universal,
-                    GramNeg_1, GramNeg_2, GramNeg_3,
-                    GramNeg_4, GramNeg_5, GramNeg_6)
-  gram_negative <- gram_negative[!is.null(gram_negative)]
-  gram_negative <- gram_negative[!is.na(gram_negative)]
-  if (length(gram_negative) < 12) {
-    warning("only using ", length(gram_negative), " different antibiotics as key antibiotics for Gram-negatives. See ?key_antibiotics.", call. = FALSE)
-  }
-
-  # join to microorganisms data set
-  x <- x %>%
-    as.data.frame(stringsAsFactors = FALSE) %>% 
-    mutate_at(vars(col_mo), as.mo) %>%
-    left_join_microorganisms(by = col_mo) %>%
-    mutate(key_ab = NA_character_,
-           gramstain = mo_gramstain(pull(., col_mo), language = NULL))
-  
-  # Gram +
-  x <- x %>% mutate(key_ab =
-                      if_else(gramstain == "Gram-positive",
-                              tryCatch(apply(X = x[, gram_positive],
-                                             MARGIN = 1,
-                                             FUN = function(x) paste(x, collapse = "")),
-                                       error = function(e) paste0(rep(".", 12), collapse = "")),
-                              key_ab))
-  
-  # Gram -
-  x <- x %>% mutate(key_ab =
-                      if_else(gramstain == "Gram-negative",
-                              tryCatch(apply(X = x[, gram_negative],
-                                             MARGIN = 1,
-                                             FUN = function(x) paste(x, collapse = "")),
-                                       error = function(e) paste0(rep(".", 12), collapse = "")),
-                              key_ab))
-
-  # format
-  key_abs <- x %>%
-    pull(key_ab) %>%
-    gsub("(NA|NULL)", ".", .) %>%
-    gsub("[^SIR]", ".", ., ignore.case = TRUE) %>%
-    toupper()
-  
-  if (n_distinct(key_abs) == 1) {
-    warning("No distinct key antibiotics determined.", call. = FALSE)
-  }
-
-  key_abs
-
-}
-
-#' @importFrom dplyr progress_estimated %>%
-#' @rdname key_antibiotics
-#' @export
-key_antibiotics_equal <- function(y,
-                                  z,
-                                  type = c("keyantibiotics", "points"),
-                                  ignore_I = TRUE,
-                                  points_threshold = 2,
-                                  info = FALSE) {
-  # y is active row, z is lag
-  x <- y
-  y <- z
-
-  type <- type[1]
-
-  if (length(x) != length(y)) {
-    stop("Length of `x` and `y` must be equal.")
-  }
-
-  # only show progress bar on points or when at least 5000 isolates
-  info_needed <- info == TRUE & (type == "points" | length(x) > 5000)
-
-  result <- logical(length(x))
-
-  if (info_needed == TRUE) {
-    p <- dplyr::progress_estimated(length(x))
-  }
-
-  for (i in seq_len(length(x))) {
-
-    if (info_needed == TRUE) {
-      p$tick()$print()
-    }
-
-    if (is.na(x[i])) {
-      x[i] <- ""
-    }
-    if (is.na(y[i])) {
-      y[i] <- ""
-    }
-
-    if (x[i] == y[i]) {
-
-      result[i] <- TRUE
-
-    } else if (nchar(x[i]) != nchar(y[i])) {
-
-      result[i] <- FALSE
-
-    } else {
-
-      x_split <- strsplit(x[i], "")[[1]]
-      y_split <- strsplit(y[i], "")[[1]]
-
-      if (type == "keyantibiotics") {
-
-        if (ignore_I == TRUE) {
-          x_split[x_split == "I"] <- "."
-          y_split[y_split == "I"] <- "."
-        }
-
-        y_split[x_split == "."] <- "."
-        x_split[y_split == "."] <- "."
-
-        result[i] <- all(x_split == y_split)
-
-      } else if (type == "points") {
-        # count points for every single character:
-        # - no change is 0 points
-        # - I <-> S|R is 0.5 point
-        # - S|R <-> R|S is 1 point
-        # use the levels of as.rsi (S = 1, I = 2, R = 3)
-
-        suppressWarnings(x_split <- x_split %>% as.rsi() %>% as.double())
-        suppressWarnings(y_split <- y_split %>% as.rsi() %>% as.double())
-
-        points <- (x_split - y_split) %>% abs() %>% sum(na.rm = TRUE) / 2
-        result[i] <- points >= points_threshold
-
-      } else {
-        stop("`", type, '` is not a valid value for type, must be "points" or "keyantibiotics". See ?key_antibiotics')
-      }
-    }
-  }
-  if (info_needed == TRUE) {
-    cat("\n")
-  }
-  result
-}

R/kurtosis.R

@@ -1,61 +0,0 @@
-# ==================================================================== #
-# TITLE                                                                #
-# Antimicrobial Resistance (AMR) Analysis                              #
-#                                                                      #
-# SOURCE                                                               #
-# https://gitlab.com/msberends/AMR                                     #
-#                                                                      #
-# LICENCE                                                              #
-# (c) 2019 Berends MS (m.s.berends@umcg.nl), Luz CF (c.f.luz@umcg.nl)  #
-#                                                                      #
-# This R package is free software; you can freely use and distribute   #
-# it for both personal and commercial purposes under the terms of the  #
-# GNU General Public License version 2.0 (GNU GPL-2), as published by  #
-# the Free Software Foundation.                                        #
-#                                                                      #
-# This R package was created for academic research and was publicly    #
-# released in the hope that it will be useful, but it comes WITHOUT    #
-# ANY WARRANTY OR LIABILITY.                                           #
-# Visit our website for more info: https://msberends.gitlab.io/AMR.    #
-# ==================================================================== #
-
-#' Kurtosis of the sample
-#'
-#' @description Kurtosis is a measure of the "tailedness" of the probability distribution of a real-valued random variable.
-#' @param x a vector of values, a [`matrix`] or a [`data.frame`]
-#' @param na.rm a logical value indicating whether `NA` values should be stripped before the computation proceeds.
-#' @exportMethod kurtosis
-#' @seealso [skewness()]
-#' @rdname kurtosis
-#' @inheritSection AMR Read more on our website!
-#' @export
-kurtosis <- function(x, na.rm = FALSE) {
-  UseMethod("kurtosis")
-}
-
-#' @exportMethod kurtosis.default
-#' @rdname kurtosis
-#' @export
-kurtosis.default <- function(x, na.rm = FALSE) {
-  x <- as.vector(x)
-  if (na.rm == TRUE) {
-    x <- x[!is.na(x)]
-  }
-  n <- length(x)
-  n * base::sum((x - base::mean(x, na.rm = na.rm))^4, na.rm = na.rm) /
-    (base::sum((x - base::mean(x, na.rm = na.rm))^2, na.rm = na.rm)^2)
-}
-
-#' @exportMethod kurtosis.matrix
-#' @rdname kurtosis
-#' @export
-kurtosis.matrix <- function(x, na.rm = FALSE) {
-  base::apply(x, 2, kurtosis.default, na.rm = na.rm)
-}
-
-#' @exportMethod kurtosis.data.frame
-#' @rdname kurtosis
-#' @export
-kurtosis.data.frame <- function(x, na.rm = FALSE) {
-  base::sapply(x, kurtosis.default, na.rm = na.rm)
-}

R/like.R

@@ -1,107 +0,0 @@
-# ==================================================================== #
-# TITLE                                                                #
-# Antimicrobial Resistance (AMR) Analysis                              #
-#                                                                      #
-# SOURCE                                                               #
-# https://gitlab.com/msberends/AMR                                     #
-#                                                                      #
-# LICENCE                                                              #
-# (c) 2019 Berends MS (m.s.berends@umcg.nl), Luz CF (c.f.luz@umcg.nl)  #
-#                                                                      #
-# This R package is free software; you can freely use and distribute   #
-# it for both personal and commercial purposes under the terms of the  #
-# GNU General Public License version 2.0 (GNU GPL-2), as published by  #
-# the Free Software Foundation.                                        #
-#                                                                      #
-# This R package was created for academic research and was publicly    #
-# released in the hope that it will be useful, but it comes WITHOUT    #
-# ANY WARRANTY OR LIABILITY.                                           #
-# Visit our website for more info: https://msberends.gitlab.io/AMR.    #
-# ==================================================================== #
-
-#' Pattern Matching
-#'
-#' Convenient wrapper around [base::grep()] to match a pattern: `a %like% b`. It always returns a [`logical`] vector and is always case-insensitive (use `a %like_case% b` for case-sensitive matching). Also, `pattern` (*b*) can be as long as `x` (*a*) to compare items of each index in both vectors, or can both have the same length to iterate over all cases.
-#' @param x a character vector where matches are sought, or an object which can be coerced by [as.character()] to a character vector.
-#' @param pattern a character string containing a regular expression (or [`character`] string for `fixed = TRUE`) to be matched in the given character vector. Coerced by [as.character()] to a character string if possible.  If a [`character`] vector of length 2 or more is supplied, the first element is used with a warning.
-#' @param ignore.case if `FALSE`, the pattern matching is *case sensitive* and if `TRUE`, case is ignored during matching.
-#' @return A [`logical`] vector
-#' @name like
-#' @rdname like
-#' @export
-#' @details Using RStudio? This function can also be inserted from the Addins menu and can have its own Keyboard Shortcut like `Ctrl+Shift+L` or `Cmd+Shift+L` (see `Tools` > `Modify Keyboard Shortcuts...`).
-#' @source Idea from the [`like` function from the `data.table` package](https://github.com/Rdatatable/data.table/blob/master/R/like.R), but made it case insensitive at default and let it support multiple patterns. Also, if the regex fails the first time, it tries again with `perl = TRUE`.
-#' @seealso [base::grep()]
-#' @inheritSection AMR Read more on our website!
-#' @examples
-#' # simple test
-#' a <- "This is a test"
-#' b <- "TEST"
-#' a %like% b
-#' #> TRUE
-#' b %like% a
-#' #> FALSE
-#'
-#' # also supports multiple patterns, length must be equal to x
-#' a <- c("Test case", "Something different", "Yet another thing")
-#' b <- c("case", "diff", "yet")
-#' a %like% b
-#' #> TRUE TRUE TRUE
-#'
-#' # get frequencies of bacteria whose name start with 'Ent' or 'ent'
-#' library(dplyr)
-#' example_isolates %>%
-#'   filter(mo_genus(mo) %like% '^ent') %>%
-#'   freq(mo_fullname(mo))
-like <- function(x, pattern, ignore.case = TRUE) {
-  if (length(pattern) > 1) {
-    if (length(x) != length(pattern)) {
-      if (length(x) == 1) {
-        x <- rep(x, length(pattern))
-      }
-      # return TRUE for every 'x' that matches any 'pattern', FALSE otherwise
-      res <- sapply(pattern, function(pttrn) base::grepl(pttrn, x, ignore.case = ignore.case))
-      res2 <- as.logical(rowSums(res))
-      # get only first item of every hit in pattern
-      res2[duplicated(res)] <- FALSE
-      res2[rowSums(res) == 0] <- NA
-      return(res2)
-    } else {
-      # x and pattern are of same length, so items with each other
-      res <- vector(length = length(pattern))
-      for (i in seq_len(length(res))) {
-        if (is.factor(x[i])) {
-          res[i] <- as.integer(x[i]) %in% base::grep(pattern[i], levels(x[i]), ignore.case = ignore.case)
-        } else {
-          res[i] <- base::grepl(pattern[i], x[i], ignore.case = ignore.case)
-        }
-      }
-      return(res)
-    }
-  }
-
-  # the regular way how grepl works; just one pattern against one or more x
-  if (is.factor(x)) {
-    as.integer(x) %in% base::grep(pattern, levels(x), ignore.case = ignore.case)
-  } else {
-    tryCatch(base::grepl(pattern, x, ignore.case = ignore.case),
-             error = function(e) ifelse(grepl("Invalid regexp", e$message),
-                                        # try with perl = TRUE:
-                                        return(base::grepl(pattern = pattern, x = x,
-                                                                 ignore.case = ignore.case, perl = TRUE)),
-                                        # stop otherwise
-                                        stop(e$message)))
-  }
-}
-
-#' @rdname like
-#' @export
-"%like%" <- function(x, pattern) {
-  like(x, pattern, ignore.case = TRUE)
-}
-
-#' @rdname like
-#' @export
-"%like_case%" <- function(x, pattern) {
-  like(x, pattern, ignore.case = FALSE)
-}

R/mic.R

@@ -1,241 +0,0 @@
-# ==================================================================== #
-# TITLE                                                                #
-# Antimicrobial Resistance (AMR) Analysis                              #
-#                                                                      #
-# SOURCE                                                               #
-# https://gitlab.com/msberends/AMR                                     #
-#                                                                      #
-# LICENCE                                                              #
-# (c) 2019 Berends MS (m.s.berends@umcg.nl), Luz CF (c.f.luz@umcg.nl)  #
-#                                                                      #
-# This R package is free software; you can freely use and distribute   #
-# it for both personal and commercial purposes under the terms of the  #
-# GNU General Public License version 2.0 (GNU GPL-2), as published by  #
-# the Free Software Foundation.                                        #
-#                                                                      #
-# This R package was created for academic research and was publicly    #
-# released in the hope that it will be useful, but it comes WITHOUT    #
-# ANY WARRANTY OR LIABILITY.                                           #
-# Visit our website for more info: https://msberends.gitlab.io/AMR.    #
-# ==================================================================== #
-
-#' Class 'mic'
-#'
-#' This transforms a vector to a new class [`mic`], which is an ordered [`factor`] with valid MIC values as levels. Invalid MIC values will be translated as `NA` with a warning.
-#' @rdname as.mic
-#' @param x vector
-#' @param na.rm a logical indicating whether missing values should be removed
-#' @details To interpret MIC values as RSI values, use [as.rsi()] on MIC values. It supports guidelines from EUCAST and CLSI.
-#' @return Ordered [`factor`] with new class [`mic`]
-#' @aliases mic
-#' @export
-#' @importFrom dplyr %>%
-#' @seealso [as.rsi()]
-#' @inheritSection AMR Read more on our website!
-#' @examples
-#' mic_data <- as.mic(c(">=32", "1.0", "1", "1.00", 8, "<=0.128", "8", "16", "16"))
-#' is.mic(mic_data)
-#'
-#' # this can also coerce combined MIC/RSI values:
-#' as.mic("<=0.002; S") # will return <=0.002
-#'
-#' # interpret MIC values
-#' as.rsi(x = as.mic(2),
-#'        mo = as.mo("S. pneumoniae"),
-#'        ab = "AMX",
-#'        guideline = "EUCAST")
-#' as.rsi(x = as.mic(4),
-#'        mo = as.mo("S. pneumoniae"),
-#'        ab = "AMX",
-#'        guideline = "EUCAST")
-#'
-#' plot(mic_data)
-#' barplot(mic_data)
-#' freq(mic_data)
-as.mic <- function(x, na.rm = FALSE) {
-  if (is.mic(x)) {
-    x
-  } else {
-    x <- x %>% unlist()
-    if (na.rm == TRUE) {
-      x <- x[!is.na(x)]
-    }
-    x.bak <- x
-
-    # comma to period
-    x <- gsub(",", ".", x, fixed = TRUE)
-    # remove space between operator and number ("<= 0.002" -> "<=0.002")
-    x <- gsub("(<|=|>) +", "\\1", x)
-    # transform => to >= and =< to <=
-    x <- gsub("=>", ">=", x, fixed = TRUE)
-    x <- gsub("=<", "<=", x, fixed = TRUE)
-    # starting dots must start with 0
-    x <- gsub("^[.]+", "0.", x)
-    # <=0.2560.512 should be 0.512
-    x <- gsub(".*[.].*[.]", "0.", x)
-    # remove ending .0
-    x <- gsub("[.]+0$", "", x)
-    # remove all after last digit
-    x <- gsub("[^0-9]+$", "", x)
-    # keep only one zero before dot
-    x <- gsub("0+[.]", "0.", x)
-    # starting 00 is probably 0.0 if there's no dot yet
-    x[!x %like% "[.]"] <- gsub("^00", "0.0", x[!x %like% "[.]"])
-    # remove last zeroes
-    x <- gsub("([.].?)0+$", "\\1", x)
-    x <- gsub("(.*[.])0+$", "\\10", x)
-    # remove ending .0 again
-    x[x %like% "[.]"] <- gsub("0+$", "", x[x %like% "[.]"])
-    # force to be character
-    x <- as.character(x)
-    # trim it
-    x <- trimws(x)
-
-    ## previously unempty values now empty - should return a warning later on
-    x[x.bak != "" & x == ""] <- "invalid"
-
-    # these are allowed MIC values and will become factor levels
-    ops <- c("<", "<=", "", ">=", ">")
-    lvls <- c(c(t(sapply(ops, function(x) paste0(x, "0.00", 1:9)))),
-              unique(c(t(sapply(ops, function(x) paste0(x, sort(as.double(paste0("0.0", 
-                                                                                 sort(c(1:99, 125, 128, 256, 512, 625)))))))))),
-              unique(c(t(sapply(ops, function(x) paste0(x, sort(as.double(paste0("0.", 
-                                                                                 c(1:99, 125, 128, 256, 512))))))))),
-              c(t(sapply(ops, function(x) paste0(x, sort(c(1:9, 1.5)))))),
-              c(t(sapply(ops, function(x) paste0(x, c(10:98)[9:98 %% 2 == TRUE])))),
-              c(t(sapply(ops, function(x) paste0(x, sort(c(2 ^ c(7:10), 80 * c(2:12))))))))
-
-    na_before <- x[is.na(x) | x == ""] %>% length()
-    x[!x %in% lvls] <- NA
-    na_after <- x[is.na(x) | x == ""] %>% length()
-
-    if (na_before != na_after) {
-      list_missing <- x.bak[is.na(x) & !is.na(x.bak) & x.bak != ""] %>%
-        unique() %>%
-        sort()
-      list_missing <- paste0('"', list_missing, '"', collapse = ", ")
-      warning(na_after - na_before, " results truncated (",
-              round(((na_after - na_before) / length(x)) * 100),
-              "%) that were invalid MICs: ",
-              list_missing, call. = FALSE)
-    }
-
-    structure(.Data = factor(x, levels = lvls, ordered = TRUE),
-              class =  c("mic", "ordered", "factor"))
-  }
-}
-
-#' @rdname as.mic
-#' @export
-#' @importFrom dplyr %>%
-is.mic <- function(x) {
-  class(x) %>% identical(c("mic", "ordered", "factor"))
-}
-
-#' @exportMethod as.double.mic
-#' @export
-#' @noRd
-as.double.mic <- function(x, ...) {
-  as.double(gsub("(<|=|>)+", "", as.character(x)))
-}
-
-#' @exportMethod as.integer.mic
-#' @export
-#' @noRd
-as.integer.mic <- function(x, ...) {
-  as.integer(gsub("(<|=|>)+", "", as.character(x)))
-}
-
-#' @exportMethod as.numeric.mic
-#' @export
-#' @noRd
-as.numeric.mic <- function(x, ...) {
-  as.numeric(gsub("(<|=|>)+", "", as.character(x)))
-}
-
-#' @exportMethod droplevels.mic
-#' @export
-#' @noRd
-droplevels.mic <- function(x, exclude = ifelse(anyNA(levels(x)), NULL, NA), ...) {
-  x <- droplevels.factor(x, exclude = exclude, ...)
-  class(x) <- c("mic", "ordered", "factor")
-  x
-}
-
-#' @exportMethod print.mic
-#' @export
-#' @importFrom dplyr %>% tibble group_by summarise pull
-#' @noRd
-print.mic <- function(x, ...) {
-  cat("Class 'mic'\n")
-  print(as.character(x), quote = FALSE)
-}
-
-#' @exportMethod summary.mic
-#' @export
-#' @importFrom dplyr %>%
-#' @noRd
-summary.mic <- function(object, ...) {
-  x <- object
-  n_total <- x %>% length()
-  x <- x[!is.na(x)]
-  n <- x %>% length()
-  c(
-    "Class" = "mic",
-    "<NA>" = n_total - n,
-    "Min." = sort(x)[1] %>% as.character(),
-    "Max." = sort(x)[n] %>% as.character()
-  )
-}
-
-#' @exportMethod plot.mic
-#' @export
-#' @importFrom graphics barplot axis par
-#' @noRd
-plot.mic <- function(x,
-                     main = paste("MIC values of", deparse(substitute(x))),
-                     ylab = "Frequency",
-                     xlab = "MIC value",
-                     axes = FALSE,
-                     ...) {
-  barplot(table(droplevels.factor(x)),
-          ylab = ylab,
-          xlab = xlab,
-          axes = axes,
-          main = main,
-          ...)
-  axis(2, seq(0, max(table(droplevels.factor(x)))))
-}
-
-#' @exportMethod barplot.mic
-#' @export
-#' @importFrom graphics barplot axis
-#' @noRd
-barplot.mic <- function(height,
-                        main = paste("MIC values of", deparse(substitute(height))),
-                        ylab = "Frequency",
-                        xlab = "MIC value",
-                        axes = FALSE,
-                        ...) {
-  barplot(table(droplevels.factor(height)),
-          ylab = ylab,
-          xlab = xlab,
-          axes = axes,
-          main = main,
-          ...)
-  axis(2, seq(0, max(table(droplevels.factor(height)))))
-}
-
-#' @importFrom pillar type_sum
-#' @export
-type_sum.mic <- function(x) {
-  "mic"
-}
-
-#' @importFrom pillar pillar_shaft
-#' @export
-pillar_shaft.mic <- function(x, ...) {
-  out <- trimws(format(x))
-  out[is.na(x)] <- pillar::style_na(NA)
-  pillar::new_pillar_shaft_simple(out, align = "right", min_width = 4)
-}

R/misc.R

@@ -1,143 +0,0 @@
-# ==================================================================== #
-# TITLE                                                                #
-# Antimicrobial Resistance (AMR) Analysis                              #
-#                                                                      #
-# SOURCE                                                               #
-# https://gitlab.com/msberends/AMR                                     #
-#                                                                      #
-# LICENCE                                                              #
-# (c) 2019 Berends MS (m.s.berends@umcg.nl), Luz CF (c.f.luz@umcg.nl)  #
-#                                                                      #
-# This R package is free software; you can freely use and distribute   #
-# it for both personal and commercial purposes under the terms of the  #
-# GNU General Public License version 2.0 (GNU GPL-2), as published by  #
-# the Free Software Foundation.                                        #
-#                                                                      #
-# This R package was created for academic research and was publicly    #
-# released in the hope that it will be useful, but it comes WITHOUT    #
-# ANY WARRANTY OR LIABILITY.                                           #
-# Visit our website for more info: https://msberends.gitlab.io/AMR.    #
-# ==================================================================== #
-
-# No export, no Rd
-addin_insert_in <- function() {
-  rstudioapi::insertText(" %in% ")
-}
-
-# No export, no Rd
-addin_insert_like <- function() {
-  rstudioapi::insertText(" %like% ")
-}
-
-load_AMR_package <- function() {
-  if (!"package:AMR" %in% base::search()) {
-    require(AMR)
-    # check onLoad() in R/zzz.R: data tables are created there.
-  }
-  base::invisible()
-}
-
-#' @importFrom crayon blue bold red
-#' @importFrom dplyr %>% pull
-search_type_in_df <- function(x, type) {
-  # try to find columns based on type
-  found <- NULL
-
-  colnames(x) <- trimws(colnames(x))
-  
-  # -- mo
-  if (type == "mo") {
-    if ("mo" %in% lapply(x, class)) {
-      found <- colnames(x)[lapply(x, class) == "mo"][1]
-    } else if ("mo" %in% colnames(x) &
-               suppressWarnings(
-                 all(x$mo %in% c(NA,
-                                 microorganisms$mo,
-                                 microorganisms.translation$mo_old)))) {
-      found <- "mo"
-    } else if (any(colnames(x) %like% "^(mo|microorganism|organism|bacteria|bacterie)s?$")) {
-      found <- colnames(x)[colnames(x) %like% "^(mo|microorganism|organism|bacteria|bacterie)s?$"][1]
-    } else if (any(colnames(x) %like% "^(microorganism|organism|bacteria|bacterie)")) {
-      found <- colnames(x)[colnames(x) %like% "^(microorganism|organism|bacteria|bacterie)"][1]
-    } else if (any(colnames(x) %like% "species")) {
-      found <- colnames(x)[colnames(x) %like% "species"][1]
-    }
-    
-  }
-  # -- key antibiotics
-  if (type == "keyantibiotics") {
-    if (any(colnames(x) %like% "^key.*(ab|antibiotics)")) {
-      found <- colnames(x)[colnames(x) %like% "^key.*(ab|antibiotics)"][1]
-    }
-  }
-  # -- date
-  if (type == "date") {
-    if (any(colnames(x) %like% "^(specimen date|specimen_date|spec_date)")) {
-      # WHONET support
-      found <- colnames(x)[colnames(x) %like% "^(specimen date|specimen_date|spec_date)"][1]
-      if (!any(class(x %>% pull(found)) %in% c("Date", "POSIXct"))) {
-        stop(red(paste0("ERROR: Found column `", bold(found), "` to be used as input for `col_", type,
-                        "`, but this column contains no valid dates. Transform its values to valid dates first.")),
-             call. = FALSE)
-      }
-    } else {
-      for (i in seq_len(ncol(x))) {
-        if (any(class(x %>% pull(i)) %in% c("Date", "POSIXct"))) {
-          found <- colnames(x)[i]
-          break
-        }
-      }
-    }
-  }
-  # -- patient id
-  if (type == "patient_id") {
-    if (any(colnames(x) %like% "^(identification |patient|patid)")) {
-      found <- colnames(x)[colnames(x) %like% "^(identification |patient|patid)"][1]
-    }
-  }
-  # -- specimen
-  if (type == "specimen") {
-    if (any(colnames(x) %like% "(specimen type|spec_type)")) {
-      found <- colnames(x)[colnames(x) %like% "(specimen type|spec_type)"][1]
-    } else if (any(colnames(x) %like% "^(specimen)")) {
-      found <- colnames(x)[colnames(x) %like% "^(specimen)"][1]
-    }
-  }
-
-  if (!is.null(found)) {
-    msg <- paste0("NOTE: Using column `", bold(found), "` as input for `col_", type, "`.")
-    if (type %in% c("keyantibiotics", "specimen")) {
-      msg <- paste(msg, "Use", bold(paste0("col_", type), "= FALSE"), "to prevent this.")
-    }
-    message(blue(msg))
-  }
-  found
-}
-
-stopifnot_installed_package <- function(package) {
-  # no "utils::installed.packages()" since it requires non-staged install since R 3.6.0
-  # https://developer.r-project.org/Blog/public/2019/02/14/staged-install/index.html
-  get(".packageName", envir = asNamespace(package))
-  return(invisible())
-}
-
-"%or%" <- function(x, y) {
-  if (is.null(x) | is.null(y)) {
-    if (is.null(x)) {
-      return(y)
-    } else {
-      return(x)
-    }
-  }
-  ifelse(!is.na(x),
-         x,
-         ifelse(!is.na(y), y, NA))
-}
-
-class_integrity_check <- function(value, type, check_vector) {
-  if (!all(value[!is.na(value)] %in% check_vector)) {
-    warning(paste0("invalid ", type, ", NA generated"), call. = FALSE)
-    value[!value %in% check_vector] <- NA
-  }
-  value
-}

R/mo_history.R

@@ -1,199 +0,0 @@
-# ==================================================================== #
-# TITLE                                                                #
-# Antimicrobial Resistance (AMR) Analysis                              #
-#                                                                      #
-# SOURCE                                                               #
-# https://gitlab.com/msberends/AMR                                     #
-#                                                                      #
-# LICENCE                                                              #
-# (c) 2019 Berends MS (m.s.berends@umcg.nl), Luz CF (c.f.luz@umcg.nl)  #
-#                                                                      #
-# This R package is free software; you can freely use and distribute   #
-# it for both personal and commercial purposes under the terms of the  #
-# GNU General Public License version 2.0 (GNU GPL-2), as published by  #
-# the Free Software Foundation.                                        #
-#                                                                      #
-# This R package was created for academic research and was publicly    #
-# released in the hope that it will be useful, but it comes WITHOUT    #
-# ANY WARRANTY OR LIABILITY.                                           #
-# Visit our website for more info: https://msberends.gitlab.io/AMR.    #
-# ==================================================================== #
-
-# print successful as.mo coercions to a options entry
-#' @importFrom dplyr %>% distinct filter
-#' @importFrom utils write.csv
-set_mo_history <- function(x, mo, uncertainty_level, force = FALSE, disable = FALSE) {
-  if (isTRUE(disable)) {
-    return(base::invisible())
-  }
-  
-  # don't save codes that are in a code data set already
-  mo <- mo[!x %in% microorganisms.codes$code & !x %in% microorganisms.translation$mo_old]
-  x <- x[!x %in% microorganisms.codes$code & !x %in% microorganisms.translation$mo_old]
-  
-  warning_new_write <- FALSE
-  
-  if (base::interactive() | force == TRUE) {
-    mo_hist <- read_mo_history(uncertainty_level = uncertainty_level, force = force)
-    df <- data.frame(x, mo, stringsAsFactors = FALSE) %>%
-      distinct(x, .keep_all = TRUE) %>%
-      filter(!is.na(x) & !is.na(mo))
-    if (nrow(df) == 0) {
-      return(base::invisible())
-    }
-    x <- toupper(df$x)
-    mo <- df$mo
-    for (i in seq_len(length(x))) {
-      # save package version too, as both the as.mo() algorithm and the reference data set may change
-      if (NROW(mo_hist[base::which(mo_hist$x == x[i] &
-                                   mo_hist$uncertainty_level >= uncertainty_level &
-                                   mo_hist$package_version == utils::packageVersion("AMR")), ]) == 0) {
-        if (is.null(mo_hist) & interactive()) {
-          warning_new_write <- TRUE
-        }
-        tryCatch(write.csv(rbind(mo_hist,
-                                 data.frame(
-                                   x = x[i],
-                                   mo = mo[i],
-                                   uncertainty_level = uncertainty_level,
-                                   package_version = base::as.character(utils::packageVersion("AMR")),
-                                   stringsAsFactors = FALSE)),
-                           row.names = FALSE,
-                           file = mo_history_file()),
-                 error = function(e) {
-                   warning_new_write <- FALSE; base::invisible()
-                 })
-      }
-    }
-  }
-  if (warning_new_write == TRUE) {
-    message(blue(paste0("NOTE: results are saved to ", mo_history_file(), ".")))
-  }
-  return(base::invisible())
-}
-
-get_mo_history <- function(x, uncertainty_level, force = FALSE, disable = FALSE) {
-  if (isTRUE(disable)) {
-    return(to_class_mo(NA))
-  }
-  
-  history <- read_mo_history(uncertainty_level = uncertainty_level, force = force)
-  if (base::is.null(history)) {
-    result <- NA
-  } else {
-    result <- data.frame(x = as.character(toupper(x)), stringsAsFactors = FALSE) %>%
-      left_join(history, by = "x") %>%
-      pull(mo)
-  }
-  to_class_mo(result)
-}
-
-#' @importFrom dplyr %>% filter distinct
-#' @importFrom utils read.csv
-read_mo_history <- function(uncertainty_level = 2, force = FALSE, unfiltered = FALSE, disable = FALSE) {
-  if (isTRUE(disable)) {
-    return(NULL)
-  }
-  
-  if ((!base::interactive() & force == FALSE)) {
-    return(NULL)
-  }
-  uncertainty_level_param <- uncertainty_level
-  
-  history <- tryCatch(read.csv(mo_history_file(), stringsAsFactors = FALSE),
-                      warning = function(w) invisible(),
-                      error = function(e) NULL)
-  if (is.null(history)) {
-    return(NULL)
-  }
-  # Below: filter on current package version.
-  # Even current fullnames may be replaced by new taxonomic names, so new versions of
-  # the Catalogue of Life must not lead to data corruption.
-  
-  if (unfiltered == FALSE) {
-    history <- history %>%
-      filter(package_version == as.character(utils::packageVersion("AMR")),
-             # only take unknowns if uncertainty_level_param is higher
-             ((mo == "UNKNOWN" & uncertainty_level_param == uncertainty_level) |
-                (mo != "UNKNOWN" & uncertainty_level_param >= uncertainty_level))) %>%
-      arrange(desc(uncertainty_level)) %>%
-      distinct(x, mo, .keep_all = TRUE)
-  }
-  
-  if (nrow(history) == 0) {
-    NULL
-  } else {
-    history
-  }
-}
-
-#' @rdname as.mo
-#' @importFrom crayon red
-#' @importFrom utils menu
-#' @export
-clear_mo_history <- function(...) {
-  if (!is.null(read_mo_history())) {
-    if (interactive() & !isTRUE(list(...)$force)) {
-      q <- menu(title = paste("This will clear all",
-                              format(nrow(read_mo_history(999, unfiltered = TRUE)), big.mark = ","),
-                              "previously determined microbial IDs. Are you sure?"),
-                choices = c("Yes", "No"),
-                graphics = FALSE)
-      if (q != 1) {
-        return(invisible())
-      }
-    }
-
-    success <- create_blank_mo_history()
-    if (!isFALSE(success)) {
-      cat(red(paste("File", mo_history_file(), "cleared.")))
-    }
-  }
-}
-
-#' @importFrom utils write.csv
-create_blank_mo_history <- function() {
-  tryCatch(
-    write.csv(x = data.frame(x = character(0),
-                             mo = character(0),
-                             uncertainty_level = integer(0),
-                             package_version = character(0),
-                             stringsAsFactors = FALSE),
-              row.names = FALSE,
-              file = mo_history_file()),
-    warning = function(w) invisible(),
-    error = function(e) TRUE)
-}
-
-
-# Borrowed all below code from the extrafont package,
-# https://github.com/wch/extrafont/blob/254c3f99b02f11adb59affbda699a92aec8624f5/R/utils.r
-inst_path <- function() {
-  envname <- environmentName(parent.env(environment()))
-  
-  # If installed in package, envname == "AMR"
-  # If loaded with load_all, envname == "package:AMR"
-  # (This is kind of strange)
-  if (envname == "AMR") {
-    system.file(package = "AMR")
-  } else {
-    srcfile <- attr(attr(inst_path, "srcref"), "srcfile")
-    file.path(dirname(dirname(srcfile$filename)), "inst")
-  }
-}
-
-
-# Get the path where extrafontdb is installed
-db_path <- function() {
-  system.file(package = "AMR")
-}
-
-# fonttable file
-mo_history_file <- function() {
-  file.path(mo_history_path(), "mo_history.csv")
-}
-
-# Path of fontmap directory
-mo_history_path <- function() {
-  file.path(db_path(), "mo_history")
-}

R/mo_property.R

@@ -1,434 +0,0 @@
-# ==================================================================== #
-# TITLE                                                                #
-# Antimicrobial Resistance (AMR) Analysis                              #
-#                                                                      #
-# SOURCE                                                               #
-# https://gitlab.com/msberends/AMR                                     #
-#                                                                      #
-# LICENCE                                                              #
-# (c) 2019 Berends MS (m.s.berends@umcg.nl), Luz CF (c.f.luz@umcg.nl)  #
-#                                                                      #
-# This R package is free software; you can freely use and distribute   #
-# it for both personal and commercial purposes under the terms of the  #
-# GNU General Public License version 2.0 (GNU GPL-2), as published by  #
-# the Free Software Foundation.                                        #
-#                                                                      #
-# This R package was created for academic research and was publicly    #
-# released in the hope that it will be useful, but it comes WITHOUT    #
-# ANY WARRANTY OR LIABILITY.                                           #
-# Visit our website for more info: https://msberends.gitlab.io/AMR.    #
-# ==================================================================== #
-
-#' Property of a microorganism
-#'
-#' Use these functions to return a specific property of a microorganism. All input values will be evaluated internally with [as.mo()], which makes it possible for input of these functions to use microbial abbreviations, codes and names. See Examples.
-#' @param x any (vector of) text that can be coerced to a valid microorganism code with [as.mo()]
-#' @param property one of the column names of the [microorganisms] data set or `"shortname"`
-#' @param language language of the returned text, defaults to system language (see [get_locale()]) and can also be set with `getOption("AMR_locale")`. Use `language = NULL` or `language = ""` to prevent translation.
-#' @param ... other parameters passed on to [as.mo()]
-#' @param open browse the URL using [utils::browseURL()]
-#' @details All functions will return the most recently known taxonomic property according to the Catalogue of Life, except for [mo_ref()], [mo_authors()] and [mo_year()]. This leads to the following results:
-#' - `mo_name("Chlamydia psittaci")` will return `"Chlamydophila psittaci"` (with a warning about the renaming)
-#' - `mo_ref("Chlamydia psittaci")` will return `"Page, 1968"` (with a warning about the renaming)
-#' - `mo_ref("Chlamydophila psittaci")` will return `"Everett et al., 1999"` (without a warning)
-#'
-#' The Gram stain - [mo_gramstain()] - will be determined on the taxonomic kingdom and phylum. According to Cavalier-Smith (2002) who defined subkingdoms Negibacteria and Posibacteria, only these phyla are Posibacteria: Actinobacteria, Chloroflexi, Firmicutes and Tenericutes. These bacteria are considered Gram positive - all other bacteria are considered Gram negative. Species outside the kingdom of Bacteria will return a value `NA`.
-#'
-#' All output will be [translate]d where possible.
-#'
-#' The function [mo_url()] will return the direct URL to the online database entry, which also shows the scientific reference of the concerned species.
-#' @inheritSection catalogue_of_life Catalogue of Life
-#' @inheritSection as.mo Source
-#' @rdname mo_property
-#' @name mo_property
-#' @return
-#' - An [`integer`] in case of [mo_year()]
-#' - A [`list`] in case of [mo_taxonomy()]
-#' - A named [`character`] in case of [mo_url()]
-#' - A [`character`] in all other cases
-#' @export
-#' @seealso [microorganisms]
-#' @inheritSection AMR Read more on our website!
-#' @examples
-#' # taxonomic tree -----------------------------------------------------------
-#' mo_kingdom("E. coli")         # "Bacteria"
-#' mo_phylum("E. coli")          # "Proteobacteria"
-#' mo_class("E. coli")           # "Gammaproteobacteria"
-#' mo_order("E. coli")           # "Enterobacterales"
-#' mo_family("E. coli")          # "Enterobacteriaceae"
-#' mo_genus("E. coli")           # "Escherichia"
-#' mo_species("E. coli")         # "coli"
-#' mo_subspecies("E. coli")      # ""
-#'
-#' # colloquial properties ----------------------------------------------------
-#' mo_name("E. coli")            # "Escherichia coli"
-#' mo_fullname("E. coli")        # "Escherichia coli", same as mo_name()
-#' mo_shortname("E. coli")       # "E. coli"
-#'
-#' # other properties ---------------------------------------------------------
-#' mo_gramstain("E. coli")       # "Gram-negative"
-#' mo_type("E. coli")            # "Bacteria" (equal to kingdom, but may be translated)
-#' mo_rank("E. coli")            # "species"
-#' mo_url("E. coli")             # get the direct url to the online database entry
-#' mo_synonyms("E. coli")        # get previously accepted taxonomic names
-#'
-#' # scientific reference -----------------------------------------------------
-#' mo_ref("E. coli")             # "Castellani et al., 1919"
-#' mo_authors("E. coli")         # "Castellani et al."
-#' mo_year("E. coli")            # 1919
-#'
-#' # abbreviations known in the field -----------------------------------------
-#' mo_genus("MRSA")              # "Staphylococcus"
-#' mo_species("MRSA")            # "aureus"
-#' mo_shortname("VISA")          # "S. aureus"
-#' mo_gramstain("VISA")          # "Gram-positive"
-#'
-#' mo_genus("EHEC")              # "Escherichia"
-#' mo_species("EHEC")            # "coli"
-#'
-#' # known subspecies ---------------------------------------------------------
-#' mo_name("doylei")             # "Campylobacter jejuni doylei"
-#' mo_genus("doylei")            # "Campylobacter"
-#' mo_species("doylei")          # "jejuni"
-#' mo_subspecies("doylei")       # "doylei"
-#'
-#' mo_fullname("K. pneu rh")     # "Klebsiella pneumoniae rhinoscleromatis"
-#' mo_shortname("K. pneu rh")    # "K. pneumoniae"
-#'
-#' \donttest{
-#' # Becker classification, see ?as.mo ----------------------------------------
-#' mo_fullname("S. epi")                     # "Staphylococcus epidermidis"
-#' mo_fullname("S. epi", Becker = TRUE)      # "Coagulase-negative Staphylococcus (CoNS)"
-#' mo_shortname("S. epi")                    # "S. epidermidis"
-#' mo_shortname("S. epi", Becker = TRUE)     # "CoNS"
-#'
-#' # Lancefield classification, see ?as.mo ------------------------------------
-#' mo_fullname("S. pyo")                     # "Streptococcus pyogenes"
-#' mo_fullname("S. pyo", Lancefield = TRUE)  # "Streptococcus group A"
-#' mo_shortname("S. pyo")                    # "S. pyogenes"
-#' mo_shortname("S. pyo", Lancefield = TRUE) # "GAS" (='Group A Streptococci')
-#'
-#'
-#' # language support for German, Dutch, Spanish, Portuguese, Italian and French
-#' mo_gramstain("E. coli", language = "de")  # "Gramnegativ"
-#' mo_gramstain("E. coli", language = "nl")  # "Gram-negatief"
-#' mo_gramstain("E. coli", language = "es")  # "Gram negativo"
-#'
-#' # mo_type is equal to mo_kingdom, but mo_kingdom will remain official
-#' mo_kingdom("E. coli")                     # "Bacteria" on a German system
-#' mo_type("E. coli")                        # "Bakterien" on a German system
-#' mo_type("E. coli")                        # "Bacteria" on an English system
-#'
-#' mo_fullname("S. pyogenes",
-#'             Lancefield = TRUE,
-#'             language = "de")              # "Streptococcus Gruppe A"
-#' mo_fullname("S. pyogenes",
-#'             Lancefield = TRUE,
-#'             language = "nl")              # "Streptococcus groep A"
-#'
-#'
-#' # get a list with the complete taxonomy (from kingdom to subspecies)
-#' mo_taxonomy("E. coli")
-#' # get a list with the taxonomy, the authors, Gram-stain and URL to the online database
-#' mo_info("E. coli")
-#' }
-mo_name <- function(x, language = get_locale(), ...) {
-  translate_AMR(mo_validate(x = x, property = "fullname", ...), language = language, only_unknown = FALSE)
-}
-
-#' @rdname mo_property
-#' @export
-mo_fullname <- mo_name
-
-#' @rdname mo_property
-#' @export
-mo_shortname <- function(x, language = get_locale(), ...) {
-  x.mo <- AMR::as.mo(x, ...)
-  metadata <- get_mo_failures_uncertainties_renamed()
-
-  replace_empty <- function(x) {
-    x[x == ""] <- "spp."
-    x
-  }
-  
-  # get first char of genus and complete species in English
-  shortnames <- paste0(substr(mo_genus(x.mo, language = NULL), 1, 1), ". ", replace_empty(mo_species(x.mo, language = NULL)))
-  
-  # exceptions for Staphylococci
-  shortnames[shortnames == "S. coagulase-negative"] <- "CoNS"
-  shortnames[shortnames == "S. coagulase-positive"] <- "CoPS"
-  # exceptions for Streptococci: Streptococcus Group A -> GAS
-  shortnames[shortnames %like% "S. group [ABCDFGHK]"] <- paste0("G", gsub("S. group ([ABCDFGHK])", "\\1", shortnames[shortnames %like% "S. group [ABCDFGHK]"]), "S")
-
-  load_mo_failures_uncertainties_renamed(metadata)
-  translate_AMR(shortnames, language = language, only_unknown = FALSE)
-}
-
-#' @rdname mo_property
-#' @export
-mo_subspecies <- function(x, language = get_locale(), ...) {
-  translate_AMR(mo_validate(x = x, property = "subspecies", ...), language = language, only_unknown = TRUE)
-}
-
-#' @rdname mo_property
-#' @export
-mo_species <- function(x, language = get_locale(), ...) {
-  translate_AMR(mo_validate(x = x, property = "species", ...), language = language, only_unknown = TRUE)
-}
-
-#' @rdname mo_property
-#' @export
-mo_genus <- function(x, language = get_locale(), ...) {
-  translate_AMR(mo_validate(x = x, property = "genus", ...), language = language, only_unknown = TRUE)
-}
-
-#' @rdname mo_property
-#' @export
-mo_family <- function(x, language = get_locale(), ...) {
-  translate_AMR(mo_validate(x = x, property = "family", ...), language = language, only_unknown = TRUE)
-}
-
-#' @rdname mo_property
-#' @export
-mo_order <- function(x, language = get_locale(), ...) {
-  translate_AMR(mo_validate(x = x, property = "order", ...), language = language, only_unknown = TRUE)
-}
-
-#' @rdname mo_property
-#' @export
-mo_class <- function(x, language = get_locale(), ...) {
-  translate_AMR(mo_validate(x = x, property = "class", ...), language = language, only_unknown = TRUE)
-}
-
-#' @rdname mo_property
-#' @export
-mo_phylum <- function(x, language = get_locale(), ...) {
-  translate_AMR(mo_validate(x = x, property = "phylum", ...), language = language, only_unknown = TRUE)
-}
-
-#' @rdname mo_property
-#' @export
-mo_kingdom <- function(x, language = get_locale(), ...) {
-  translate_AMR(mo_validate(x = x, property = "kingdom", ...), language = language, only_unknown = TRUE)
-}
-
-#' @rdname mo_property
-#' @export
-mo_type <- function(x, language = get_locale(), ...) {
-  translate_AMR(mo_validate(x = x, property = "kingdom", ...), language = language, only_unknown = FALSE)
-}
-
-#' @rdname mo_property
-#' @export
-mo_gramstain <- function(x, language = get_locale(), ...) {
-  x.mo <- AMR::as.mo(x, ...)
-  metadata <- get_mo_failures_uncertainties_renamed()
-
-  x.phylum <- mo_phylum(x.mo)
-  # DETERMINE GRAM STAIN FOR BACTERIA
-  # Source: https://itis.gov/servlet/SingleRpt/SingleRpt?search_topic=TSN&search_value=956097
-  # It says this:
-  # Kingdom Bacteria (Cavalier-Smith, 2002)
-  #    Subkingdom Posibacteria (Cavalier-Smith, 2002)
-  #   Direct Children:
-  #       Phylum  Actinobacteria (Cavalier-Smith, 2002)
-  #       Phylum  Chloroflexi (Garrity and Holt, 2002)
-  #       Phylum  Firmicutes (corrig. Gibbons and Murray, 1978)
-  #       Phylum  Tenericutes (Murray, 1984)
-  x <- NA_character_
-  # make all bacteria Gram negative
-  x[mo_kingdom(x.mo) == "Bacteria"] <- "Gram-negative"
-  # overwrite these phyla with Gram positive
-  x[x.phylum %in% c("Actinobacteria",
-                    "Chloroflexi",
-                    "Firmicutes",
-                    "Tenericutes")
-    | x.mo == "B_GRAMP"] <- "Gram-positive"
-
-  load_mo_failures_uncertainties_renamed(metadata)
-  translate_AMR(x, language = language, only_unknown = FALSE)
-}
-
-#' @rdname mo_property
-#' @export
-mo_ref <- function(x, ...) {
-  mo_validate(x = x, property = "ref", ...)
-}
-
-#' @rdname mo_property
-#' @export
-mo_authors <- function(x, ...) {
-  x <- mo_validate(x = x, property = "ref", ...)
-  # remove last 4 digits and presumably the comma and space that preceed them
-  x[!is.na(x)] <- gsub(",? ?[0-9]{4}", "", x[!is.na(x)])
-  suppressWarnings(x)
-}
-
-#' @rdname mo_property
-#' @export
-mo_year <- function(x, ...) {
-  x <- mo_validate(x = x, property = "ref", ...)
-  # get last 4 digits
-  x[!is.na(x)] <- gsub(".*([0-9]{4})$", "\\1", x[!is.na(x)])
-  suppressWarnings(as.integer(x))
-}
-
-#' @rdname mo_property
-#' @export
-mo_rank <- function(x, ...) {
-  mo_validate(x = x, property = "rank", ...)
-}
-
-#' @rdname mo_property
-#' @export
-mo_taxonomy <- function(x, language = get_locale(),  ...) {
-  x <- AMR::as.mo(x, ...)
-  metadata <- get_mo_failures_uncertainties_renamed()
-
-  result <- base::list(kingdom = AMR::mo_kingdom(x, language = language),
-             phylum = AMR::mo_phylum(x, language = language),
-             class = AMR::mo_class(x, language = language),
-             order = AMR::mo_order(x, language = language),
-             family = AMR::mo_family(x, language = language),
-             genus = AMR::mo_genus(x, language = language),
-             species = AMR::mo_species(x, language = language),
-             subspecies = AMR::mo_subspecies(x, language = language))
-
-  load_mo_failures_uncertainties_renamed(metadata)
-  result
-}
-
-#' @rdname mo_property
-#' @export
-mo_synonyms <- function(x, ...) {
-  x <- AMR::as.mo(x, ...)
-  metadata <- get_mo_failures_uncertainties_renamed()
-
-  IDs <- AMR::mo_property(x = x, property = "col_id", language = NULL)
-  syns <- lapply(IDs, function(col_id) {
-    res <- sort(AMR::microorganisms.old[which(AMR::microorganisms.old$col_id_new == col_id), "fullname"])
-    if (length(res) == 0) {
-      NULL
-    } else {
-      res
-    }
-  })
-  if (length(syns) > 1) {
-    names(syns) <- mo_name(x)
-    result <- syns
-  } else {
-    result <- unlist(syns)
-  }
-
-  load_mo_failures_uncertainties_renamed(metadata)
-  result
-}
-
-#' @rdname mo_property
-#' @export
-mo_info <- function(x, language = get_locale(),  ...) {
-  x <- AMR::as.mo(x, ...)
-  metadata <- get_mo_failures_uncertainties_renamed()
-
-  info <- lapply(x, function(y)
-    c(mo_taxonomy(y, language = language),
-      list(synonyms = mo_synonyms(y),
-           gramstain = mo_gramstain(y, language = language),
-           url = unname(mo_url(y, open = FALSE)),
-           ref = mo_ref(y))))
-  if (length(info) > 1) {
-    names(info) <- mo_name(x)
-    result <- info
-  } else {
-    result <- info[[1L]]
-  }
-
-  load_mo_failures_uncertainties_renamed(metadata)
-  result
-}
-
-#' @rdname mo_property
-#' @importFrom utils browseURL
-#' @importFrom dplyr %>% left_join select mutate case_when
-#' @export
-mo_url <- function(x, open = FALSE, ...) {
-  mo <- AMR::as.mo(x = x, ... = ...)
-  mo_names <- AMR::mo_name(mo)
-  metadata <- get_mo_failures_uncertainties_renamed()
-
-  df <- data.frame(mo, stringsAsFactors = FALSE) %>%
-    left_join(select(AMR::microorganisms, mo, source, species_id), by = "mo") %>%
-    mutate(url = case_when(source == "CoL" ~
-                             paste0(gsub("{year}", catalogue_of_life$year, catalogue_of_life$url_CoL, fixed = TRUE), "details/species/id/", species_id),
-                           source == "DSMZ" ~
-                             paste0(catalogue_of_life$url_DSMZ, "/", unlist(lapply(strsplit(mo_names, ""), function(x) x[1]))),
-                           TRUE ~
-                             NA_character_))
-
-  u <- df$url
-  names(u) <- mo_names
-  if (open == TRUE) {
-    if (length(u) > 1) {
-      warning("only the first URL will be opened, as `browseURL()` only suports one string.")
-    }
-    browseURL(u[1L])
-  }
-
-  load_mo_failures_uncertainties_renamed(metadata)
-  u
-}
-
-
-#' @rdname mo_property
-#' @importFrom data.table data.table as.data.table setkey
-#' @export
-mo_property <- function(x, property = "fullname", language = get_locale(), ...) {
-  if (length(property) != 1L) {
-    stop("'property' must be of length 1.")
-  }
-  if (!property %in% colnames(AMR::microorganisms)) {
-    stop("invalid property: '", property, "' - use a column name of the `microorganisms` data set")
-  }
-
-  translate_AMR(mo_validate(x = x, property = property, ...), language = language, only_unknown = TRUE)
-}
-
-mo_validate <- function(x, property, ...) {
-  
-  load_AMR_package()
-
-  dots <- list(...)
-  Becker <- dots$Becker
-  if (is.null(Becker)) {
-    Becker <- FALSE
-  }
-  Lancefield <- dots$Lancefield
-  if (is.null(Lancefield)) {
-    Lancefield <- FALSE
-  }
-
-  # try to catch an error when inputting an invalid parameter
-  # so the 'call.' can be set to FALSE
-  tryCatch(x[1L] %in% AMR::microorganisms[1, property],
-           error = function(e) stop(e$message, call. = FALSE))
-  
-  if (is.mo(x) 
-      & !Becker %in% c(TRUE, "all") 
-      & !Lancefield %in% c(TRUE, "all")) {
-    # this will not reset mo_uncertainties and mo_failures
-    # because it's already a valid MO
-    x <- exec_as.mo(x, property = property, initial_search = FALSE, ...)
-  } else if (!all(x %in% pull(AMR::microorganisms, property))
-             | Becker %in% c(TRUE, "all")
-             | Lancefield %in% c(TRUE, "all")) {
-    x <- exec_as.mo(x, property = property, ...)
-  }
-  
-  if (property == "mo") {
-    return(to_class_mo(x))
-  } else if (property == "col_id") {
-    return(as.integer(x))
-  } else {
-    return(x)
-  }
-}

R/mo_source.R

@@ -1,223 +0,0 @@
-# ==================================================================== #
-# TITLE                                                                #
-# Antimicrobial Resistance (AMR) Analysis                              #
-#                                                                      #
-# SOURCE                                                               #
-# https://gitlab.com/msberends/AMR                                     #
-#                                                                      #
-# LICENCE                                                              #
-# (c) 2019 Berends MS (m.s.berends@umcg.nl), Luz CF (c.f.luz@umcg.nl)  #
-#                                                                      #
-# This R package is free software; you can freely use and distribute   #
-# it for both personal and commercial purposes under the terms of the  #
-# GNU General Public License version 2.0 (GNU GPL-2), as published by  #
-# the Free Software Foundation.                                        #
-#                                                                      #
-# This R package was created for academic research and was publicly    #
-# released in the hope that it will be useful, but it comes WITHOUT    #
-# ANY WARRANTY OR LIABILITY.                                           #
-# Visit our website for more info: https://msberends.gitlab.io/AMR.    #
-# ==================================================================== #
-
-#' Use predefined reference data set
-#'
-#' @description These functions can be used to predefine your own reference to be used in [as.mo()] and consequently all `mo_*` functions like [mo_genus()] and [mo_gramstain()].
-#'
-#' This is **the fastest way** to have your organisation (or analysis) specific codes picked up and translated by this package.
-#' @param path location of your reference file, see Details
-#' @rdname mo_source
-#' @name mo_source
-#' @aliases set_mo_source get_mo_source
-#' @details The reference file can be a text file seperated with commas (CSV) or tabs or pipes, an Excel file (either 'xls' or 'xlsx' format) or an R object file (extension '.rds'). To use an Excel file, you need to have the `readxl` package installed.
-#'
-#' [set_mo_source()] will check the file for validity: it must be a [`data.frame`], must have a column named `"mo"` which contains values from [`microorganisms$mo`][microorganisms] and must have a reference column with your own defined values. If all tests pass, [set_mo_source()] will read the file into R and export it to `"~/.mo_source.rds"`. This compressed data file will then be used at default for MO determination (function [as.mo()] and consequently all `mo_*` functions like [mo_genus()] and [mo_gramstain()]). The location of the original file will be saved as option with `options(mo_source = path)`. Its timestamp will be saved with `options(mo_source_datetime = ...)`.
-#'
-#' [get_mo_source()] will return the data set by reading `"~/.mo_source.rds"` with [readRDS()]. If the original file has changed (the file defined with `path`), it will call [set_mo_source()] to update the data file automatically.
-#'
-#' Reading an Excel file (`.xlsx`) with only one row has a size of 8-9 kB. The compressed file used by this package will have a size of 0.1 kB and can be read by [get_mo_source()] in only a couple of microseconds (a millionth of a second).
-#' 
-#' ## How it works
-#' 
-#' Imagine this data on a sheet of an Excel file (mo codes were looked up in the `microorganisms` data set). The first column contains the organisation specific codes, the second column contains an MO code from this package:
-#' ```
-#'   |         A          |      B      |
-#' --|--------------------|-------------|
-#' 1 | Organisation XYZ   | mo          |
-#' 2 | lab_mo_ecoli       | B_ESCHR_COL |
-#' 3 | lab_mo_kpneumoniae | B_KLBSL_PNE |
-#' 4 |                    |             |
-#' ```
-#'
-#' We save it as `"home/me/ourcodes.xlsx"`. Now we have to set it as a source:
-#' ```
-#' set_mo_source("home/me/ourcodes.xlsx")
-#' # Created mo_source file '~/.mo_source.rds' from 'home/me/ourcodes.xlsx'.
-#' ```
-#'
-#' It has now created a file `"~/.mo_source.rds"` with the contents of our Excel file, but only the first column with foreign values and the 'mo' column will be kept.
-#'
-#' And now we can use it in our functions:
-#' ```
-#' as.mo("lab_mo_ecoli")
-#' \[1\] B_ESCHR_COLI
-#'
-#' mo_genus("lab_mo_kpneumoniae")
-#' [1] "Klebsiella"
-#'
-#' # other input values still work too
-#' as.mo(c("Escherichia coli", "E. coli", "lab_mo_ecoli"))
-#' [1] B_ESCHR_COLI B_ESCHR_COLI B_ESCHR_COLI
-#' ```
-#'
-#' If we edit the Excel file to, let's say, this:
-#' ```
-#'   |         A          |       B      |
-#' --|--------------------|--------------|
-#' 1 | Organisation XYZ   | mo           |
-#' 2 | lab_mo_ecoli       | B_ESCHR_COLI |
-#' 3 | lab_mo_kpneumoniae | B_KLBSL_PNMN |
-#' 4 | lab_Staph_aureus   | B_STPHY_AURS |
-#' 5 |                    |              |
-#' ```
-#'
-#' ...any new usage of an MO function in this package will update your data:
-#' ```
-#' as.mo("lab_mo_ecoli")
-#' # Updated mo_source file '~/.mo_source.rds' from 'home/me/ourcodes.xlsx'.
-#' [1] B_ESCHR_COLI
-#'
-#' mo_genus("lab_Staph_aureus")
-#' [1] "Staphylococcus"
-#' ```
-#'
-#' To remove the reference completely, just use any of these:
-#' ```
-#' set_mo_source("")
-#' set_mo_source(NULL)
-#' # Removed mo_source file '~/.mo_source.rds'.
-#' ```
-#' @importFrom dplyr select everything
-#' @export
-#' @inheritSection AMR Read more on our website!
-set_mo_source <- function(path) {
-
-  file_location <- path.expand("~/mo_source.rds")
-
-  if (!is.character(path) | length(path) > 1) {
-    stop("`path` must be a character of length 1.")
-  }
-
-  if (path %in% c(NULL, "")) {
-    options(mo_source = NULL)
-    options(mo_source_timestamp = NULL)
-    if (file.exists(file_location)) {
-      unlink(file_location)
-      message("Removed mo_source file '", file_location, "'.")
-    }
-    return(invisible())
-  }
-
-  if (!file.exists(path)) {
-    stop("File not found: ", path)
-  }
-
-  if (path %like% "[.]rds$") {
-    df <- readRDS(path)
-
-  } else if (path %like% "[.]xlsx?$") {
-    # is Excel file (old or new)
-    if (!"readxl" %in% utils::installed.packages()) {
-      stop("Install the 'readxl' package first.")
-    }
-    df <- readxl::read_excel(path)
-
-  } else if (path %like% "[.]tsv$") {
-    df <- utils::read.table(header = TRUE, sep = "\t", stringsAsFactors = FALSE)
-
-  } else {
-    # try comma first
-    try(
-      df <- utils::read.table(header = TRUE, sep = ",", stringsAsFactors = FALSE),
-      silent = TRUE)
-    if (!mo_source_isvalid(df)) {
-      # try tab
-      try(
-        df <- utils::read.table(header = TRUE, sep = "\t", stringsAsFactors = FALSE),
-        silent = TRUE)
-    }
-    if (!mo_source_isvalid(df)) {
-      # try pipe
-      try(
-        df <- utils::read.table(header = TRUE, sep = "|", stringsAsFactors = FALSE),
-        silent = TRUE)
-    }
-  }
-
-  if (!mo_source_isvalid(df)) {
-    stop("File must contain a column with self-defined values and a reference column `mo` with valid values from the `microorganisms` data set.")
-  }
-
-  df <- df %>% filter(!is.na(mo))
-
-  # keep only first two columns, second must be mo
-  if (colnames(df)[1] == "mo") {
-    df <- df[, c(2, 1)]
-  } else {
-    df <- df[, c(1, 2)]
-  }
-
-  df <- as.data.frame(df, stringAsFactors = FALSE)
-
-  # success
-  if (file.exists(file_location)) {
-    action <- "Updated"
-  } else {
-    action <- "Created"
-  }
-  saveRDS(df, file_location)
-  options(mo_source = path)
-  options(mo_source_timestamp = as.character(file.info(path)$mtime))
-  message(action, " mo_source file '", file_location, "' from '", path, "'.")
-}
-
-#' @rdname mo_source
-#' @export
-get_mo_source <- function() {
-  if (is.null(getOption("mo_source", NULL))) {
-    NULL
-  } else {
-    old_time <- as.POSIXct(getOption("mo_source_timestamp"))
-    new_time <- as.POSIXct(as.character(file.info(getOption("mo_source", ""))$mtime))
-
-    if (is.na(new_time)) {
-      # source file was deleted, remove reference too
-      set_mo_source("")
-      return(NULL)
-    }
-    if (new_time != old_time) {
-      # set updated source
-      set_mo_source(getOption("mo_source"))
-    }
-    file_location <- path.expand("~/mo_source.rds")
-    readRDS(file_location)
-  }
-}
-
-mo_source_isvalid <- function(x) {
-  if (deparse(substitute(x)) == "get_mo_source()") {
-    return(TRUE)
-  }
-  if (identical(x, get_mo_source())) {
-    return(TRUE)
-  }
-  if (is.null(x)) {
-    return(TRUE)
-  }
-  if (!is.data.frame(x)) {
-    return(FALSE)
-  }
-  if (!"mo" %in% colnames(x)) {
-    return(FALSE)
-  }
-  all(x$mo %in% c("", AMR::microorganisms$mo))
-}

R/p_symbol.R

@@ -1,42 +0,0 @@
-# ==================================================================== #
-# TITLE                                                                #
-# Antimicrobial Resistance (AMR) Analysis                              #
-#                                                                      #
-# SOURCE                                                               #
-# https://gitlab.com/msberends/AMR                                     #
-#                                                                      #
-# LICENCE                                                              #
-# (c) 2019 Berends MS (m.s.berends@umcg.nl), Luz CF (c.f.luz@umcg.nl)  #
-#                                                                      #
-# This R package is free software; you can freely use and distribute   #
-# it for both personal and commercial purposes under the terms of the  #
-# GNU General Public License version 2.0 (GNU GPL-2), as published by  #
-# the Free Software Foundation.                                        #
-#                                                                      #
-# This R package was created for academic research and was publicly    #
-# released in the hope that it will be useful, but it comes WITHOUT    #
-# ANY WARRANTY OR LIABILITY.                                           #
-# Visit our website for more info: https://msberends.gitlab.io/AMR.    #
-# ==================================================================== #
-
-#' Symbol of a p-value
-#'
-#' Return the symbol related to the p-value: 0 '`***`' 0.001 '`**`' 0.01 '`*`' 0.05 '`.`' 0.1 ' ' 1. Values above `p = 1` will return `NA`.
-#' @param p p value
-#' @param emptychar text to show when `p > 0.1`
-#' @return Text
-#' @inheritSection AMR Read more on our website!
-#' @export
-p_symbol <- function(p, emptychar = " ") {
-
-  p <- as.double(p)
-  s <- rep(NA_character_, length(p))
-
-  s[p <= 1] <- emptychar
-  s[p <= 0.100] <- "."
-  s[p <= 0.050] <- "*"
-  s[p <= 0.010] <- "**"
-  s[p <= 0.001] <- "***"
-  
-  s
-}

R/proportion.R

@@ -1,286 +0,0 @@
-# ==================================================================== #
-# TITLE                                                                #
-# Antimicrobial Resistance (AMR) Analysis                              #
-#                                                                      #
-# SOURCE                                                               #
-# https://gitlab.com/msberends/AMR                                     #
-#                                                                      #
-# LICENCE                                                              #
-# (c) 2019 Berends MS (m.s.berends@umcg.nl), Luz CF (c.f.luz@umcg.nl)  #
-#                                                                      #
-# This R package is free software; you can freely use and distribute   #
-# it for both personal and commercial purposes under the terms of the  #
-# GNU General Public License version 2.0 (GNU GPL-2), as published by  #
-# the Free Software Foundation.                                        #
-#                                                                      #
-# This R package was created for academic research and was publicly    #
-# released in the hope that it will be useful, but it comes WITHOUT    #
-# ANY WARRANTY OR LIABILITY.                                           #
-# Visit our website for more info: https://msberends.gitlab.io/AMR.    #
-# ==================================================================== #
-
-#' Calculate microbial resistance
-#'
-#' @description These functions can be used to calculate the (co-)resistance or susceptibility of microbial isolates (i.e. percentage of S, SI, I, IR or R). All functions support quasiquotation with pipes, can be used in [dplyr::summarise()] and support grouped variables, please see *Examples*.
-#'
-#' [resistance()] should be used to calculate resistance, [susceptibility()] should be used to calculate susceptibility.\cr
-#' @param ... one or more vectors (or columns) with antibiotic interpretations. They will be transformed internally with [as.rsi()] if needed. Use multiple columns to calculate (the lack of) co-resistance: the probability where one of two drugs have a resistant or susceptible result. See Examples.
-#' @param minimum the minimum allowed number of available (tested) isolates. Any isolate count lower than `minimum` will return `NA` with a warning. The default number of `30` isolates is advised by the Clinical and Laboratory Standards Institute (CLSI) as best practice, see Source.
-#' @param as_percent a logical to indicate whether the output must be returned as a hundred fold with % sign (a character). A value of `0.123456` will then be returned as `"12.3%"`.
-#' @param only_all_tested (for combination therapies, i.e. using more than one variable for `...`): a logical to indicate that isolates must be tested for all antibiotics, see section *Combination therapy* below
-#' @param data a [`data.frame`] containing columns with class [`rsi`] (see [as.rsi()])
-#' @param translate_ab a column name of the [antibiotics] data set to translate the antibiotic abbreviations to, using [ab_property()]
-#' @inheritParams ab_property
-#' @param combine_SI a logical to indicate whether all values of S and I must be merged into one, so the output only consists of S+I vs. R (susceptible vs. resistant). This used to be the parameter `combine_IR`, but this now follows the redefinition by EUCAST about the interpretion of I (increased exposure) in 2019, see section 'Interpretation of S, I and R' below. Default is `TRUE`.
-#' @param combine_IR a logical to indicate whether all values of I and R must be merged into one, so the output only consists of S vs. I+R (susceptible vs. non-susceptible). This is outdated, see parameter `combine_SI`.
-#' @inheritSection as.rsi Interpretation of R and S/I
-#' @details
-#' The function [resistance()] is equal to the function [proportion_R()]. The function [susceptibility()] is equal to the function [proportion_SI()].
-#'  
-#' **Remember that you should filter your table to let it contain only first isolates!** This is needed to exclude duplicates and to reduce selection bias. Use [first_isolate()] to determine them in your data set.
-#'
-#' These functions are not meant to count isolates, but to calculate the proportion of resistance/susceptibility. Use the [AMR::count()] functions to count isolates. The function [susceptibility()] is essentially equal to `count_susceptible() / count_all()`. *Low counts can infuence the outcome - the `proportion` functions may camouflage this, since they only return the proportion (albeit being dependent on the `minimum` parameter).*
-#'
-#' The function [proportion_df()] takes any variable from `data` that has an [`rsi`] class (created with [as.rsi()]) and calculates the proportions R, I and S. The function [rsi_df()] works exactly like [proportion_df()], but adds the number of isolates.
-#' @section Combination therapy:
-#' When using more than one variable for `...` (= combination therapy)), use `only_all_tested` to only count isolates that are tested for all antibiotics/variables that you test them for. See this example for two antibiotics, Antibiotic A and Antibiotic B, about how [susceptibility()] works to calculate the %SI:
-#'
-#' ```
-#' --------------------------------------------------------------------
-#'                     only_all_tested = FALSE  only_all_tested = TRUE
-#'                     -----------------------  -----------------------
-#'  Drug A    Drug B   include as  include as   include as  include as
-#'                     numerator   denominator  numerator   denominator
-#' --------  --------  ----------  -----------  ----------  -----------
-#'  S or I    S or I       X            X            X            X
-#'    R       S or I       X            X            X            X
-#'   <NA>     S or I       X            X            -            -
-#'  S or I      R          X            X            X            X
-#'    R         R          -            X            -            X
-#'   <NA>       R          -            -            -            -
-#'  S or I     <NA>        X            X            -            -
-#'    R        <NA>        -            -            -            -
-#'   <NA>      <NA>        -            -            -            -
-#' --------------------------------------------------------------------
-#' ```
-#'
-#' Please note that, in combination therapies, for `only_all_tested = TRUE` applies that:
-#' ```
-#'     count_S()    +   count_I()    +   count_R()    = count_all()
-#'   proportion_S() + proportion_I() + proportion_R() = 1
-#' ```
-#' and that, in combination therapies, for `only_all_tested = FALSE` applies that:
-#' ```
-#'     count_S()    +   count_I()    +   count_R()    >= count_all()
-#'   proportion_S() + proportion_I() + proportion_R() >= 1
-#' ```
-#'
-#' Using `only_all_tested` has no impact when only using one antibiotic as input.
-#' @source **M39 Analysis and Presentation of Cumulative Antimicrobial Susceptibility Test Data, 4th Edition**, 2014, *Clinical and Laboratory Standards Institute (CLSI)*. <https://clsi.org/standards/products/microbiology/documents/m39/>.
-#' @seealso [AMR::count()] to count resistant and susceptible isolates.
-#' @return A [`double`] or, when `as_percent = TRUE`, a [`character`].
-#' @rdname proportion
-#' @aliases portion
-#' @name proportion
-#' @export
-#' @inheritSection AMR Read more on our website!
-#' @examples
-#' # example_isolates is a data set available in the AMR package.
-#' ?example_isolates
-#' 
-#' resistance(example_isolates$AMX)     # determines %R
-#' susceptibility(example_isolates$AMX) # determines %S+I
-#'
-#' # be more specific
-#' proportion_S(example_isolates$AMX)
-#' proportion_SI(example_isolates$AMX)
-#' proportion_I(example_isolates$AMX)
-#' proportion_IR(example_isolates$AMX)
-#' proportion_R(example_isolates$AMX)
-#'
-#' library(dplyr)
-#' example_isolates %>%
-#'   group_by(hospital_id) %>%
-#'   summarise(r = resistance(CIP),
-#'             n = n_rsi(CIP)) # n_rsi works like n_distinct in dplyr, see ?n_rsi
-#'
-#' example_isolates %>%
-#'   group_by(hospital_id) %>%
-#'   summarise(R  = resistance(CIP, as_percent = TRUE),
-#'             SI = susceptibility(CIP, as_percent = TRUE),
-#'             n1 = count_all(CIP),  # the actual total; sum of all three
-#'             n2 = n_rsi(CIP),      # same - analogous to n_distinct
-#'             total = n())          # NOT the number of tested isolates!
-#'
-#' # Calculate co-resistance between amoxicillin/clav acid and gentamicin,
-#' # so we can see that combination therapy does a lot more than mono therapy:
-#' example_isolates %>% susceptibility(AMC)  # %SI = 76.3%
-#' example_isolates %>% count_all(AMC)       #   n = 1879
-#'
-#' example_isolates %>% susceptibility(GEN)  # %SI = 75.4%
-#' example_isolates %>% count_all(GEN)       #   n = 1855
-#'
-#' example_isolates %>% susceptibility(AMC, GEN) # %SI = 94.1%
-#' example_isolates %>% count_all(AMC, GEN)      #   n = 1939
-#'
-#'
-#' # See Details on how `only_all_tested` works. Example:
-#' example_isolates %>%
-#'   summarise(numerator = count_susceptible(AMC, GEN),
-#'             denominator = count_all(AMC, GEN),
-#'             proportion = susceptibility(AMC, GEN))
-
-#' example_isolates %>%
-#'   summarise(numerator = count_susceptible(AMC, GEN, only_all_tested = TRUE),
-#'             denominator = count_all(AMC, GEN, only_all_tested = TRUE),
-#'             proportion = susceptibility(AMC, GEN, only_all_tested = TRUE))
-
-#'
-#'
-#' example_isolates %>%
-#'   group_by(hospital_id) %>%
-#'   summarise(cipro_p = susceptibility(CIP, as_percent = TRUE),
-#'             cipro_n = count_all(CIP),
-#'             genta_p = susceptibility(GEN, as_percent = TRUE),
-#'             genta_n = count_all(GEN),
-#'             combination_p = susceptibility(CIP, GEN, as_percent = TRUE),
-#'             combination_n = count_all(CIP, GEN))
-#'
-#' # Get proportions S/I/R immediately of all rsi columns
-#' example_isolates %>%
-#'   select(AMX, CIP) %>%
-#'   proportion_df(translate = FALSE)
-#'
-#' # It also supports grouping variables
-#' example_isolates %>%
-#'   select(hospital_id, AMX, CIP) %>%
-#'   group_by(hospital_id) %>%
-#'   proportion_df(translate = FALSE)
-#'
-#'
-#' \dontrun{
-#'
-#' # calculate current empiric combination therapy of Helicobacter gastritis:
-#' my_table %>%
-#'   filter(first_isolate == TRUE,
-#'          genus == "Helicobacter") %>%
-#'   summarise(p = susceptibility(AMX, MTR),  # amoxicillin with metronidazole
-#'             n = count_all(AMX, MTR))
-#' }
-resistance <- function(...,
-                       minimum = 30,
-                       as_percent = FALSE,
-                       only_all_tested = FALSE) {
-  rsi_calc(...,
-           ab_result = "R",
-           minimum = minimum,
-           as_percent = as_percent,
-           only_all_tested = only_all_tested,
-           only_count = FALSE)
-}
-
-#' @rdname proportion
-#' @export
-susceptibility <- function(...,
-                           minimum = 30,
-                           as_percent = FALSE,
-                           only_all_tested = FALSE) {
-  rsi_calc(...,
-           ab_result = c("S", "I"),
-           minimum = minimum,
-           as_percent = as_percent,
-           only_all_tested = only_all_tested,
-           only_count = FALSE)
-}
-
-#' @rdname proportion
-#' @export
-proportion_R <- function(...,
-                         minimum = 30,
-                         as_percent = FALSE,
-                         only_all_tested = FALSE) {
-  rsi_calc(...,
-           ab_result = "R",
-           minimum = minimum,
-           as_percent = as_percent,
-           only_all_tested = only_all_tested,
-           only_count = FALSE)
-}
-
-#' @rdname proportion
-#' @export
-proportion_IR <- function(...,
-                          minimum = 30,
-                          as_percent = FALSE,
-                          only_all_tested = FALSE) {
-  rsi_calc(...,
-           ab_result = c("I", "R"),
-           minimum = minimum,
-           as_percent = as_percent,
-           only_all_tested = only_all_tested,
-           only_count = FALSE)
-}
-
-#' @rdname proportion
-#' @export
-proportion_I <- function(...,
-                         minimum = 30,
-                         as_percent = FALSE,
-                         only_all_tested = FALSE) {
-  rsi_calc(...,
-           ab_result = "I",
-           minimum = minimum,
-           as_percent = as_percent,
-           only_all_tested = only_all_tested,
-           only_count = FALSE)
-}
-
-#' @rdname proportion
-#' @export
-proportion_SI <- function(...,
-                          minimum = 30,
-                          as_percent = FALSE,
-                          only_all_tested = FALSE) {
-  rsi_calc(...,
-           ab_result = c("S", "I"),
-           minimum = minimum,
-           as_percent = as_percent,
-           only_all_tested = only_all_tested,
-           only_count = FALSE)
-}
-
-#' @rdname proportion
-#' @export
-proportion_S <- function(...,
-                         minimum = 30,
-                         as_percent = FALSE,
-                         only_all_tested = FALSE) {
-  rsi_calc(...,
-           ab_result = "S",
-           minimum = minimum,
-           as_percent = as_percent,
-           only_all_tested = only_all_tested,
-           only_count = FALSE)
-}
-
-#' @rdname proportion
-#' @importFrom dplyr %>% select_if bind_rows summarise_if mutate group_vars select everything
-#' @export
-proportion_df <- function(data,
-                          translate_ab = "name",
-                          language = get_locale(),
-                          minimum = 30,
-                          as_percent = FALSE,
-                          combine_SI = TRUE,
-                          combine_IR = FALSE) {
-  
-  rsi_calc_df(type = "proportion",
-              data = data,
-              translate_ab = translate_ab,
-              language = language,
-              minimum = minimum,
-              as_percent = as_percent,
-              combine_SI = combine_SI,
-              combine_IR = combine_IR,
-              combine_SI_missing = missing(combine_SI))
-}

R/read.4d.R

@@ -1,175 +0,0 @@
-# ==================================================================== #
-# TITLE                                                                #
-# Antimicrobial Resistance (AMR) Analysis                              #
-#                                                                      #
-# SOURCE                                                               #
-# https://gitlab.com/msberends/AMR                                     #
-#                                                                      #
-# LICENCE                                                              #
-# (c) 2019 Berends MS (m.s.berends@umcg.nl), Luz CF (c.f.luz@umcg.nl)  #
-#                                                                      #
-# This R package is free software; you can freely use and distribute   #
-# it for both personal and commercial purposes under the terms of the  #
-# GNU General Public License version 2.0 (GNU GPL-2), as published by  #
-# the Free Software Foundation.                                        #
-#                                                                      #
-# This R package was created for academic research and was publicly    #
-# released in the hope that it will be useful, but it comes WITHOUT    #
-# ANY WARRANTY OR LIABILITY.                                           #
-# Visit our website for more info: https://msberends.gitlab.io/AMR.    #
-# ==================================================================== #
-#
-#' Read data from 4D database
-#'
-#' This function is only useful for the MMB department of the UMCG. Use this function to **import data by just defining the `file` parameter**. It will automatically transform birth dates and calculate patients age, translate the column names to English, transform the MO codes with [as.mo()] and transform all antimicrobial columns with [as.rsi()].
-#' @inheritParams utils::read.table
-#' @param info a logical to indicate whether info about the import should be printed, defaults to `TRUE` in interactive sessions
-#' @details Column names will be transformed, but the original column names are set as a "label" attribute and can be seen in e.g. RStudio Viewer.
-#' @inheritSection AMR Read more on our website!
-#' @export
-read.4D <- function(file,
-                    info = interactive(),
-                    header = TRUE,
-                    row.names = NULL,
-                    sep = "\t",
-                    quote = "\"'",
-                    dec = ",",
-                    na.strings = c("NA", "", "."),
-                    skip = 2,
-                    check.names = TRUE,
-                    strip.white = TRUE,
-                    fill = TRUE,
-                    blank.lines.skip = TRUE,
-                    stringsAsFactors = FALSE,
-                    fileEncoding = "UTF-8",
-                    encoding = "UTF-8") {
-
-  if (info == TRUE) {
-    message("Importing ", file, "... ", appendLF = FALSE)
-  }
-  data_4D <- utils::read.table(file = file,
-                               row.names = row.names,
-                               header = header,
-                               sep = sep,
-                               quote = quote,
-                               dec = dec,
-                               na.strings = na.strings,
-                               skip = skip,
-                               check.names = check.names,
-                               strip.white = strip.white,
-                               fill = fill,
-                               blank.lines.skip = blank.lines.skip,
-                               stringsAsFactors = stringsAsFactors,
-                               fileEncoding = fileEncoding,
-                               encoding = encoding)
-
-  # helper function for dates
-  to_date_4D <- function(x) {
-    date_regular <- as.Date(x, format = "%d-%m-%y")
-    posixlt <- as.POSIXlt(date_regular)
-    # born after today will be born 100 years ago
-    # based on https://stackoverflow.com/a/3312971/4575331
-    posixlt[date_regular > Sys.Date() & !is.na(posixlt)]$year <- posixlt[date_regular > Sys.Date() & !is.na(posixlt)]$year - 100
-    as.Date(posixlt)
-  }
-
-  if (info == TRUE) {
-    message("OK\nTransforming column names... ", appendLF = FALSE)
-  }
-  if ("row.names" %in% colnames(data_4D) & all(is.na(data_4D[, ncol(data_4D)]))) {
-    # remove first column name "row.names" and remove last empty column
-    colnames(data_4D) <- c(colnames(data_4D)[2:ncol(data_4D)], "_skip_last")
-    data_4D <- data_4D[, -ncol(data_4D)]
-  }
-
-  colnames(data_4D) <- tolower(colnames(data_4D))
-  if (all(c("afnamedat", "gebdatum") %in% colnames(data_4D))) {
-    # add age column
-    data_4D$age <- NA_integer_
-  }
-  cols_wanted <- c("patientnr", "gebdatum", "age", "mv", "monsternr", "afnamedat", "bepaling",
-                   "afd.", "spec", "mat", "matbijz.",  "mocode",
-                   "amfo", "amox", "anid", "azit", "casp", "cecl", "cefe", "cfcl",
-                   "cfot", "cfox", "cfta", "cftr", "cfur", "chlo", "cipr", "clin",
-                   "cocl", "ctta", "dapt", "doxy", "eryt", "fluo", "fluz", "fosf",
-                   "fusi", "gehi", "gent", "imip", "kana", "levo", "line", "mero",
-                   "metr", "mico", "mino", "moxi", "mupi", "nali", "nitr", "norf",
-                   "oxac", "peni", "pipe", "pita", "poly", "posa", "quda", "rifa",
-                   "spat", "teic", "tige", "tobr", "trim", "trsu", "vana", "vanb",
-                   "vanc", "vori")
-  # this ones actually exist
-  cols_wanted <- cols_wanted[cols_wanted %in% colnames(data_4D)]
-  # order of columns
-  data_4D <- data_4D[, cols_wanted]
-
-  # backup original column names
-  colnames.bak <- toupper(colnames(data_4D))
-  colnames.bak[colnames.bak == "AGE"] <- NA_character_
-
-  # rename of columns
-  colnames(data_4D) <- gsub("patientnr", "patient_id", colnames(data_4D), fixed = TRUE)
-  colnames(data_4D) <- gsub("gebdatum", "date_birth", colnames(data_4D), fixed = TRUE)
-  colnames(data_4D) <- gsub("mv", "gender", colnames(data_4D), fixed = TRUE)
-  colnames(data_4D) <- gsub("monsternr", "sample_id", colnames(data_4D), fixed = TRUE)
-  colnames(data_4D) <- gsub("afnamedat", "date_received", colnames(data_4D), fixed = TRUE)
-  colnames(data_4D) <- gsub("bepaling", "sample_test", colnames(data_4D), fixed = TRUE)
-  colnames(data_4D) <- gsub("afd.", "department", colnames(data_4D), fixed = TRUE)
-  colnames(data_4D) <- gsub("spec", "specialty", colnames(data_4D), fixed = TRUE)
-  colnames(data_4D) <- gsub("matbijz.", "specimen_type", colnames(data_4D), fixed = TRUE)
-  colnames(data_4D) <- gsub("mat", "specimen_group", colnames(data_4D), fixed = TRUE)
-  colnames(data_4D) <- gsub("mocode", "mo", colnames(data_4D), fixed = TRUE)
-
-  if (info == TRUE) {
-    message("OK\nTransforming dates and age... ", appendLF = FALSE)
-  }
-  if ("date_birth" %in% colnames(data_4D)) {
-    data_4D$date_birth <- to_date_4D(data_4D$date_birth)
-  }
-  if ("date_received" %in% colnames(data_4D)) {
-    data_4D$date_received <- to_date_4D(data_4D$date_received)
-  }
-  if ("age" %in% colnames(data_4D)) {
-    data_4D$age <- age(data_4D$date_birth, data_4D$date_received)
-  }
-  if ("gender" %in% colnames(data_4D)) {
-    data_4D$gender[data_4D$gender == "V"] <- "F"
-  }
-
-  if (info == TRUE) {
-    message("OK\nTransforming MO codes... ", appendLF = FALSE)
-  }
-  if ("mo" %in% colnames(data_4D)) {
-    data_4D$mo <- as.mo(data_4D$mo)
-    # column right of mo is:
-    drug1 <- colnames(data_4D)[grep("^mo$", colnames(data_4D)) + 1]
-    if (!is.na(drug1)) {
-      # and last is:
-      drug_last <- colnames(data_4D)[length(data_4D)]
-      # transform those to rsi:
-      data_4D <- suppressWarnings(mutate_at(data_4D, vars(drug1:drug_last), as.rsi))
-    }
-  }
-
-  # set original column names as label (can be seen in RStudio Viewer)
-  if (info == TRUE) {
-    message("OK\nSetting original column names as label... ", appendLF = FALSE)
-  }
-  for (i in seq_len(ncol(data_4D))) {
-    if (!is.na(colnames.bak[i])) {
-      attr(data_4D[, i], "label") <- colnames.bak[i]
-    }
-  }
-
-  if (info == TRUE) {
-    message("OK\nSetting query as label to data.frame... ", appendLF = FALSE)
-  }
-  qry <- readLines(con <- file(file, open = "r"))[1]
-  close(con)
-  attr(data_4D, "label") <- qry
-
-  if (info == TRUE) {
-    message("OK")
-  }
-
-  data_4D
-}

R/resistance_predict.R

@@ -1,414 +0,0 @@
-# ==================================================================== #
-# TITLE                                                                #
-# Antimicrobial Resistance (AMR) Analysis                              #
-#                                                                      #
-# SOURCE                                                               #
-# https://gitlab.com/msberends/AMR                                     #
-#                                                                      #
-# LICENCE                                                              #
-# (c) 2019 Berends MS (m.s.berends@umcg.nl), Luz CF (c.f.luz@umcg.nl)  #
-#                                                                      #
-# This R package is free software; you can freely use and distribute   #
-# it for both personal and commercial purposes under the terms of the  #
-# GNU General Public License version 2.0 (GNU GPL-2), as published by  #
-# the Free Software Foundation.                                        #
-#                                                                      #
-# This R package was created for academic research and was publicly    #
-# released in the hope that it will be useful, but it comes WITHOUT    #
-# ANY WARRANTY OR LIABILITY.                                           #
-# Visit our website for more info: https://msberends.gitlab.io/AMR.    #
-# ==================================================================== #
-
-#' Predict antimicrobial resistance
-#'
-#' Create a prediction model to predict antimicrobial resistance for the next years on statistical solid ground. Standard errors (SE) will be returned as columns `se_min` and `se_max`. See *Examples* for a real live example.
-#' @param col_ab column name of `x` containing antimicrobial interpretations (`"R"`, `"I"` and `"S"`)
-#' @param col_date column name of the date, will be used to calculate years if this column doesn't consist of years already, defaults to the first column of with a date class
-#' @param year_min lowest year to use in the prediction model, dafaults to the lowest year in `col_date`
-#' @param year_max highest year to use in the prediction model, defaults to 10 years after today
-#' @param year_every unit of sequence between lowest year found in the data and `year_max`
-#' @param minimum minimal amount of available isolates per year to include. Years containing less observations will be estimated by the model.
-#' @param model the statistical model of choice. This could be a generalised linear regression model with binomial distribution (i.e. using `glm(..., family = binomial)``, assuming that a period of zero resistance was followed by a period of increasing resistance leading slowly to more and more resistance. See Details for all valid options.
-#' @param I_as_S a logical to indicate whether values `I` should be treated as `S` (will otherwise be treated as `R`). The default, `TRUE`, follows the redefinition by EUCAST about the interpretion of I (increased exposure) in 2019, see section *Interpretation of S, I and R* below. 
-#' @param preserve_measurements a logical to indicate whether predictions of years that are actually available in the data should be overwritten by the original data. The standard errors of those years will be `NA`.
-#' @param info a logical to indicate whether textual analysis should be printed with the name and [summary()] of the statistical model.
-#' @param main title of the plot
-#' @param ribbon a logical to indicate whether a ribbon should be shown (default) or error bars
-#' @param ... parameters passed on to functions
-#' @inheritSection as.rsi Interpretation of R and S/I
-#' @inheritParams first_isolate
-#' @inheritParams graphics::plot
-#' @details Valid options for the statistical model (parameter `model`) are:
-#' - `"binomial"` or `"binom"` or `"logit"`: a generalised linear regression model with binomial distribution
-#' - `"loglin"` or `"poisson"`: a generalised log-linear regression model with poisson distribution
-#' - `"lin"` or `"linear"`: a linear regression model
-#' @return A [`data.frame`] with extra class [`resistance_predict`] with columns:
-#' - `year`
-#' - `value`, the same as `estimated` when `preserve_measurements = FALSE`, and a combination of `observed` and `estimated` otherwise
-#' - `se_min`, the lower bound of the standard error with a minimum of `0` (so the standard error will never go below 0%)
-#' - `se_max` the upper bound of the standard error with a maximum of `1` (so the standard error will never go above 100%)
-#' - `observations`, the total number of available observations in that year, i.e. \eqn{S + I + R}
-#' - `observed`, the original observed resistant percentages
-#' - `estimated`, the estimated resistant percentages, calculated by the model
-#'   
-#' Furthermore, the model itself is available as an attribute: `attributes(x)$model`, please see *Examples*.
-#' @seealso The [proportion()] functions to calculate resistance
-#' 
-#' Models: [lm()] [glm()]
-#' @rdname resistance_predict
-#' @export
-#' @importFrom stats predict glm lm
-#' @importFrom dplyr %>% pull mutate mutate_at n group_by_at summarise filter filter_at all_vars n_distinct arrange case_when n_groups transmute ungroup
-#' @importFrom tidyr pivot_wider
-#' @inheritSection AMR Read more on our website!
-#' @examples
-#' x <- resistance_predict(example_isolates, 
-#'                         col_ab = "AMX",
-#'                         year_min = 2010,
-#'                         model = "binomial")
-#' plot(x)
-#' ggplot_rsi_predict(x)
-#'
-#' # use dplyr so you can actually read it:
-#' library(dplyr)
-#' x <- example_isolates %>%
-#'   filter_first_isolate() %>%
-#'   filter(mo_genus(mo) == "Staphylococcus") %>%
-#'   resistance_predict("PEN", model = "binomial")
-#' plot(x)
-#'
-#'
-#' # get the model from the object
-#' mymodel <- attributes(x)$model
-#' summary(mymodel)
-#'
-#'
-#' # create nice plots with ggplot2 yourself
-#' if (!require(ggplot2)) {
-#'
-#'   data <- example_isolates %>%
-#'     filter(mo == as.mo("E. coli")) %>%
-#'     resistance_predict(col_ab = "AMX",
-#'                        col_date = "date",
-#'                        model = "binomial",
-#'                        info = FALSE,
-#'                        minimum = 15)
-#'
-#'   ggplot(data,
-#'          aes(x = year)) +
-#'     geom_col(aes(y = value),
-#'              fill = "grey75") +
-#'     geom_errorbar(aes(ymin = se_min,
-#'                       ymax = se_max),
-#'                   colour = "grey50") +
-#'     scale_y_continuous(limits = c(0, 1),
-#'                        breaks = seq(0, 1, 0.1),
-#'                        labels = paste0(seq(0, 100, 10), "%")) +
-#'     labs(title = expression(paste("Forecast of Amoxicillin Resistance in ",
-#'                                   italic("E. coli"))),
-#'          y = "%R",
-#'          x = "Year") +
-#'     theme_minimal(base_size = 13)
-#' }
-resistance_predict <- function(x,
-                               col_ab,
-                               col_date = NULL,
-                               year_min = NULL,
-                               year_max = NULL,
-                               year_every = 1,
-                               minimum = 30,
-                               model = NULL,
-                               I_as_S = TRUE,
-                               preserve_measurements = TRUE,
-                               info = TRUE,
-                               ...) {
-
-  if (nrow(x) == 0) {
-    stop("This table does not contain any observations.")
-  }
-  
-  if (is.null(model)) {
-    stop('Choose a regression model with the `model` parameter, e.g. resistance_predict(..., model = "binomial").')
-  }
-
-  if (!col_ab %in% colnames(x)) {
-    stop("Column ", col_ab, " not found.")
-  }
-
-  dots <- unlist(list(...))
-  if (length(dots) != 0) {
-    # backwards compatibility with old parameters
-    dots.names <- dots %>% names()
-    if ("tbl" %in% dots.names) {
-      x <- dots[which(dots.names == "tbl")]
-    }
-    if ("I_as_R" %in% dots.names) {
-      warning("`I_as_R is deprecated - use I_as_S instead.", call. = FALSE)
-    }
-  }
-
-  # -- date
-  if (is.null(col_date)) {
-    col_date <- search_type_in_df(x = x, type = "date")
-  }
-  if (is.null(col_date)) {
-    stop("`col_date` must be set.", call. = FALSE)
-  }
-
-  if (!col_date %in% colnames(x)) {
-    stop("Column ", col_date, " not found.")
-  }
-
-  if (n_groups(x) > 1) {
-    # no grouped tibbles please, mutate will throw errors
-    x <- base::as.data.frame(x, stringsAsFactors = FALSE)
-  }
-
-  year <- function(x) {
-    # don't depend on lubridate or so, would be overkill for only this function
-    if (all(grepl("^[0-9]{4}$", x))) {
-      x
-    } else {
-      as.integer(format(as.Date(x), "%Y"))
-    }
-  }
-  
-  df <- x %>%
-    mutate_at(col_ab, as.rsi) %>%
-    mutate_at(col_ab, droplevels)
-  if (I_as_S == TRUE) {
-    df <- df %>%
-      mutate_at(col_ab, ~gsub("I", "S", .))
-  } else {
-    # then I as R
-    df <- df %>%
-      mutate_at(col_ab, ~gsub("I", "R", .))
-  }
-  df <- df %>% 
-    filter_at(col_ab, all_vars(!is.na(.))) %>%
-    mutate(year = year(pull(., col_date))) %>%
-    group_by_at(c("year", col_ab)) %>%
-    summarise(n())
-
-  if (df %>% pull(col_ab) %>% n_distinct(na.rm = TRUE) < 2) {
-    stop("No variety in antimicrobial interpretations - all isolates are '",
-         df %>% pull(col_ab) %>% unique(), "'.",
-         call. = FALSE)
-  }
-
-  colnames(df) <- c("year", "antibiotic", "observations")
-
-  df <- df %>%
-    filter(!is.na(antibiotic)) %>%
-    pivot_wider(names_from = antibiotic,
-                values_from = observations,
-                values_fill = list(observations = 0)) %>% 
-    filter((R + S) >= minimum)
-  df_matrix <- df %>%
-    ungroup() %>%
-    select(R, S) %>%
-    as.matrix()
-
-  if (NROW(df) == 0) {
-    stop("There are no observations.")
-  }
-
-  year_lowest <- min(df$year)
-  if (is.null(year_min)) {
-    year_min <- year_lowest
-  } else {
-    year_min <- max(year_min, year_lowest, na.rm = TRUE)
-  }
-  if (is.null(year_max)) {
-    year_max <- year(Sys.Date()) + 10
-  }
-
-  years <- list(year = seq(from = year_min, to = year_max, by = year_every))
-
-  if (model %in% c("binomial", "binom", "logit")) {
-    model <- "binomial"
-    model_lm <- with(df, glm(df_matrix ~ year, family = binomial))
-    if (info == TRUE) {
-      cat("\nLogistic regression model (logit) with binomial distribution")
-      cat("\n------------------------------------------------------------\n")
-      print(summary(model_lm))
-    }
-
-    predictmodel <- predict(model_lm, newdata = years, type = "response", se.fit = TRUE)
-    prediction <- predictmodel$fit
-    se <- predictmodel$se.fit
-
-  } else if (model %in% c("loglin", "poisson")) {
-    model <- "poisson"
-    model_lm <- with(df, glm(R ~ year, family = poisson))
-    if (info == TRUE) {
-      cat("\nLog-linear regression model (loglin) with poisson distribution")
-      cat("\n--------------------------------------------------------------\n")
-      print(summary(model_lm))
-    }
-
-    predictmodel <- predict(model_lm, newdata = years, type = "response", se.fit = TRUE)
-    prediction <- predictmodel$fit
-    se <- predictmodel$se.fit
-
-  } else if (model %in% c("lin", "linear")) {
-    model <- "linear"
-    model_lm <- with(df, lm((R / (R + S)) ~ year))
-    if (info == TRUE) {
-      cat("\nLinear regression model")
-      cat("\n-----------------------\n")
-      print(summary(model_lm))
-    }
-
-    predictmodel <- predict(model_lm, newdata = years, se.fit = TRUE)
-    prediction <- predictmodel$fit
-    se <- predictmodel$se.fit
-
-  } else {
-    stop("No valid model selected. See ?resistance_predict.")
-  }
-
-  # prepare the output dataframe
-  df_prediction <- data.frame(year = unlist(years),
-                              value = prediction,
-                              stringsAsFactors = FALSE) %>%
-
-    mutate(se_min = value - se,
-           se_max = value + se)
-
-  if (model == "poisson") {
-    df_prediction <- df_prediction %>%
-      mutate(value = value %>%
-               format(scientific = FALSE) %>%
-               as.integer(),
-             se_min = as.integer(se_min),
-             se_max = as.integer(se_max))
-  } else {
-    df_prediction <- df_prediction %>%
-      # se_max not above 1
-      mutate(se_max = ifelse(se_max > 1, 1, se_max))
-  }
-  df_prediction <- df_prediction %>%
-    # se_min not below 0
-    mutate(se_min = ifelse(se_min < 0, 0, se_min))
-
-  df_observations <- df %>%
-    ungroup() %>%
-    transmute(year,
-              observations = R + S,
-              observed = R / (R + S))
-  df_prediction <- df_prediction %>%
-    left_join(df_observations, by = "year") %>%
-    mutate(estimated = value)
-
-  if (preserve_measurements == TRUE) {
-    # replace estimated data by observed data
-    df_prediction <- df_prediction %>%
-      mutate(value = ifelse(!is.na(observed), observed, value),
-             se_min = ifelse(!is.na(observed), NA, se_min),
-             se_max = ifelse(!is.na(observed), NA, se_max))
-  }
-
-  df_prediction <- df_prediction %>%
-    mutate(value = case_when(value > 1 ~ 1,
-                             value < 0 ~ 0,
-                             TRUE ~ value)) %>%
-    arrange(year)
-
-  structure(
-    .Data = df_prediction,
-    class = c("resistance_predict", "data.frame"),
-    I_as_S = I_as_S,
-    model_title = model,
-    model = model_lm,
-    ab = col_ab
-  )
-}
-
-#' @rdname resistance_predict
-#' @export
-rsi_predict <- resistance_predict
-
-#' @exportMethod plot.mic
-#' @export
-#' @importFrom dplyr filter
-#' @importFrom graphics plot axis arrows points
-#' @rdname resistance_predict
-plot.resistance_predict <- function(x, main = paste("Resistance Prediction of", x_name), ...) {
-  x_name <- paste0(ab_name(attributes(x)$ab), " (", attributes(x)$ab, ")")
-
-  if (attributes(x)$I_as_S == TRUE) {
-    ylab <- "%R"
-  } else {
-    ylab <- "%IR"
-  }
-  plot(x = x$year,
-       y = x$value,
-       ylim = c(0, 1),
-       yaxt = "n", # no y labels
-       pch = 19, # closed dots
-       ylab = paste0("Percentage (", ylab, ")"),
-       xlab = "Year",
-       main = main,
-       sub = paste0("(n = ", sum(x$observations, na.rm = TRUE),
-                    ", model: ", attributes(x)$model_title, ")"),
-       cex.sub = 0.75)
-
-
-  axis(side = 2, at = seq(0, 1, 0.1), labels = paste0(0:10 * 10, "%"))
-
-  # hack for error bars: https://stackoverflow.com/a/22037078/4575331
-  arrows(x0 = x$year,
-         y0 = x$se_min,
-         x1 = x$year,
-         y1 = x$se_max,
-         length = 0.05, angle = 90, code = 3, lwd = 1.5)
-
-  # overlay grey points for prediction
-  points(x = filter(x, is.na(observations))$year,
-         y = filter(x, is.na(observations))$value,
-         pch = 19,
-         col = "grey40")
-}
-
-#' @rdname resistance_predict
-#' @importFrom dplyr filter
-#' @export
-ggplot_rsi_predict <- function(x,
-                               main = paste("Resistance Prediction of", x_name),
-                               ribbon = TRUE,
-                               ...) {
-  if (!"resistance_predict" %in% class(x)) {
-    stop("`x` must be a resistance prediction model created with resistance_predict().")
-  }
-
-  x_name <- paste0(ab_name(attributes(x)$ab), " (", attributes(x)$ab, ")")
-
-  if (attributes(x)$I_as_S == TRUE) {
-    ylab <- "%R"
-  } else {
-    ylab <- "%IR"
-  }
-
-  p <- ggplot2::ggplot(x, ggplot2::aes(x = year, y = value)) +
-    ggplot2::geom_point(data = filter(x, !is.na(observations)),
-                        size = 2) +
-    scale_y_percent(limits = c(0, 1)) +
-    ggplot2::labs(title = main,
-                  y = paste0("Percentage (", ylab, ")"),
-                  x = "Year",
-                  caption = paste0("(n = ", sum(x$observations, na.rm = TRUE),
-                                   ", model: ", attributes(x)$model_title, ")"))
-
-  if (ribbon == TRUE) {
-    p <- p + ggplot2::geom_ribbon(ggplot2::aes(ymin = se_min, ymax = se_max), alpha = 0.25)
-  } else {
-    p <- p + ggplot2::geom_errorbar(ggplot2::aes(ymin = se_min, ymax = se_max), na.rm = TRUE, width = 0.5)
-  }
-  p <- p +
-    # overlay grey points for prediction
-    ggplot2::geom_point(data = filter(x, is.na(observations)),
-                        size = 2,
-                        colour = "grey40")
-  p
-}

R/rsi.R

@@ -1,519 +0,0 @@
-# ==================================================================== #
-# TITLE                                                                #
-# Antimicrobial Resistance (AMR) Analysis                              #
-#                                                                      #
-# SOURCE                                                               #
-# https://gitlab.com/msberends/AMR                                     #
-#                                                                      #
-# LICENCE                                                              #
-# (c) 2019 Berends MS (m.s.berends@umcg.nl), Luz CF (c.f.luz@umcg.nl)  #
-#                                                                      #
-# This R package is free software; you can freely use and distribute   #
-# it for both personal and commercial purposes under the terms of the  #
-# GNU General Public License version 2.0 (GNU GPL-2), as published by  #
-# the Free Software Foundation.                                        #
-#                                                                      #
-# This R package was created for academic research and was publicly    #
-# released in the hope that it will be useful, but it comes WITHOUT    #
-# ANY WARRANTY OR LIABILITY.                                           #
-# Visit our website for more info: https://msberends.gitlab.io/AMR.    #
-# ==================================================================== #
-
-#' Class 'rsi'
-#'
-#' Interpret MIC values and disk diffusion diameters according to EUCAST or CLSI, or clean up existing R/SI values. This transforms the input to a new class [`rsi`], which is an ordered factor with levels `S < I < R`. Invalid antimicrobial interpretations will be translated as `NA` with a warning.
-#' @rdname as.rsi
-#' @param x vector of values (for class [`mic`]: an MIC value in mg/L, for class [`disk`]: a disk diffusion radius in millimeters)
-#' @param mo a microorganism code, generated with [as.mo()]
-#' @param ab an antimicrobial code, generated with [as.ab()]
-#' @inheritParams first_isolate
-#' @param guideline defaults to the latest included EUCAST guideline, run `unique(AMR::rsi_translation$guideline)` for all options
-#' @param threshold maximum fraction of invalid antimicrobial interpretations of `x`, please see *Examples*
-#' @param ... parameters passed on to methods
-#' @details Run `unique(AMR::rsi_translation$guideline)` for a list of all supported guidelines.
-#'
-#' After using [as.rsi()], you can use [eucast_rules()] to (1) apply inferred susceptibility and resistance based on results of other antimicrobials and (2) apply intrinsic resistance based on taxonomic properties of a microorganism.
-#'
-#' The function [is.rsi.eligible()] returns `TRUE` when a columns contains at most 5% invalid antimicrobial interpretations (not S and/or I and/or R), and `FALSE` otherwise. The threshold of 5% can be set with the `threshold` parameter.
-#' @section Interpretation of R and S/I:
-#' In 2019, the European Committee on Antimicrobial Susceptibility Testing (EUCAST) has decided to change the definitions of susceptibility testing categories R and S/I as shown below (<http://www.eucast.org/newsiandr/>). Results of several consultations on the new definitions are available on the EUCAST website under "Consultations".
-#'
-#' - **R = Resistant**\cr
-#'   A microorganism is categorised as *Resistant* when there is a high likelihood of therapeutic failure even when there is increased exposure. Exposure is a function of how the mode of administration, dose, dosing interval, infusion time, as well as distribution and excretion of the antimicrobial agent will influence the infecting organism at the site of infection.
-#' - **S = Susceptible**\cr
-#'   A microorganism is categorised as *Susceptible, standard dosing regimen*, when there is a high likelihood of therapeutic success using a standard dosing regimen of the agent.
-#' - **I = Increased exposure, but still susceptible**\cr
-#'   A microorganism is categorised as *Susceptible, Increased exposure* when there is a high likelihood of therapeutic success because exposure to the agent is increased by adjusting the dosing regimen or by its concentration at the site of infection.
-#'
-#' This AMR package honours this new insight. Use [susceptibility()] (equal to [proportion_SI()]) to determine antimicrobial susceptibility and [count_susceptible()] (equal to [count_SI()]) to count susceptible isolates.
-#' @return Ordered factor with new class [`rsi`]
-#' @aliases rsi
-#' @export
-#' @importFrom dplyr %>% desc arrange filter 
-#' @seealso [as.mic()]
-#' @inheritSection AMR Read more on our website!
-#' @examples
-#' rsi_data <- as.rsi(c(rep("S", 474), rep("I", 36), rep("R", 370)))
-#' rsi_data <- as.rsi(c(rep("S", 474), rep("I", 36), rep("R", 370), "A", "B", "C"))
-#' is.rsi(rsi_data)
-#'
-#' # this can also coerce combined MIC/RSI values:
-#' as.rsi("<= 0.002; S") # will return S
-#'
-#' # interpret MIC values
-#' as.rsi(x = as.mic(2),
-#'        mo = as.mo("S. pneumoniae"),
-#'        ab = "AMX",
-#'        guideline = "EUCAST")
-#' as.rsi(x = as.mic(4),
-#'        mo = as.mo("S. pneumoniae"),
-#'        ab = "AMX",
-#'        guideline = "EUCAST")
-#'
-#' plot(rsi_data)    # for percentages
-#' barplot(rsi_data) # for frequencies
-#' freq(rsi_data)    # frequency table with informative header
-#'
-#' # using dplyr's mutate
-#' library(dplyr)
-#' example_isolates %>%
-#'   mutate_at(vars(PEN:RIF), as.rsi)
-#'
-#'
-#' # fastest way to transform all columns with already valid AB results to class `rsi`:
-#' example_isolates %>%
-#'   mutate_if(is.rsi.eligible,
-#'             as.rsi)
-#'
-#' # default threshold of `is.rsi.eligible` is 5%.
-#' is.rsi.eligible(WHONET$`First name`) # fails, >80% is invalid
-#' is.rsi.eligible(WHONET$`First name`, threshold = 0.99) # succeeds
-as.rsi <- function(x, ...) {
-  UseMethod("as.rsi")
-}
-
-#' @export
-as.rsi.default <- function(x, ...) {
-  if (is.rsi(x)) {
-    x
-  } else if (identical(levels(x), c("S", "I", "R"))) {
-    structure(x, class = c("rsi", "ordered", "factor"))
-  } else if (identical(class(x), "integer") & all(x %in% c(1:3, NA))) {
-    x[x == 1] <- "S"
-    x[x == 2] <- "I"
-    x[x == 3] <- "R"
-    structure(.Data = factor(x, levels = c("S", "I", "R"), ordered = TRUE),
-              class =  c("rsi", "ordered", "factor"))
-  } else {
-    
-    x <- x %>% unlist()
-    x.bak <- x
-    
-    na_before <- x[is.na(x) | x == ""] %>% length()
-    # remove all spaces
-    x <- gsub(" +", "", x)
-    # remove all MIC-like values: numbers, operators and periods
-    x <- gsub("[0-9.,;:<=>]+", "", x)
-    # remove everything between brackets, and 'high' and 'low'
-    x <- gsub("([(].*[)])", "", x)
-    x <- gsub("(high|low)", "", x, ignore.case = TRUE)
-    # disallow more than 3 characters
-    x[nchar(x) > 3] <- NA
-    # set to capitals
-    x <- toupper(x)
-    # remove all invalid characters
-    x <- gsub("[^RSI]+", "", x)
-    # in cases of "S;S" keep S, but in case of "S;I" make it NA
-    x <- gsub("^S+$", "S", x)
-    x <- gsub("^I+$", "I", x)
-    x <- gsub("^R+$", "R", x)
-    x[!x %in% c("S", "I", "R")] <- NA
-    na_after <- x[is.na(x) | x == ""] %>% length()
-    
-    if (!isFALSE(list(...)$warn)) { # so as.rsi(..., warn = FALSE) will never throw a warning
-      if (na_before != na_after) {
-        list_missing <- x.bak[is.na(x) & !is.na(x.bak) & x.bak != ""] %>%
-          unique() %>%
-          sort()
-        list_missing <- paste0('"', list_missing, '"', collapse = ", ")
-        warning(na_after - na_before, " results truncated (",
-                round(((na_after - na_before) / length(x)) * 100),
-                "%) that were invalid antimicrobial interpretations: ",
-                list_missing, call. = FALSE)
-      }
-    }
-    
-    structure(.Data = factor(x, levels = c("S", "I", "R"), ordered = TRUE),
-              class =  c("rsi", "ordered", "factor"))
-  }
-}
-
-input_resembles_mic <- function(x) {
-  mic <- x %>%
-    gsub("[^0-9.,]+", "", .) %>%
-    unique()
-  mic_valid <- suppressWarnings(as.mic(mic))
-  result <- sum(!is.na(mic_valid)) / length(mic)
-  if (is.na(result)) {
-    0
-  } else {
-    result
-  }
-}
-
-#' @rdname as.rsi
-#' @importFrom dplyr case_when
-#' @export
-as.rsi.mic <- function(x, mo, ab, guideline = "EUCAST", ...) {
-  exec_as.rsi(method = "mic",
-              x = x,
-              mo = mo,
-              ab = ab,
-              guideline = guideline)
-}
-
-#' @rdname as.rsi
-#' @export
-as.rsi.disk <- function(x, mo, ab, guideline = "EUCAST", ...) {
-  exec_as.rsi(method = "disk",
-              x = x,
-              mo = mo,
-              ab = ab,
-              guideline = guideline)
-}
-
-get_guideline <- function(guideline) {
-  guideline_param <- toupper(guideline)
-  if (guideline_param %in% c("CLSI", "EUCAST")) {
-    guideline_param <- AMR::rsi_translation %>%
-      filter(guideline %like% guideline_param) %>%
-      pull(guideline) %>%
-      sort() %>%
-      rev() %>%
-      .[1]
-  }
-  
-  if (!guideline_param %in% AMR::rsi_translation$guideline) {
-    stop(paste0("invalid guideline: '", guideline,
-                "'.\nValid guidelines are: ", paste0("'", rev(sort(unique(AMR::rsi_translation$guideline))), "'", collapse = ", ")),
-         call. = FALSE)
-  }
-  
-  guideline_param
-}
-
-exec_as.rsi <- function(method, x, mo, ab, guideline) {
-  if (method == "mic") {
-    x <- as.double(as.mic(x)) # when as.rsi.mic is called directly
-    method_param <- "MIC"
-  } else if (method == "disk") {
-    x <- as.double(as.disk(x)) # when as.rsi.disk is called directly
-    method_param <- "DISK"
-  }
-  
-  mo <- as.mo(mo)
-  ab <- as.ab(ab)
-  
-  mo_genus <- as.mo(mo_genus(mo))
-  mo_family <- as.mo(mo_family(mo))
-  mo_order <- as.mo(mo_order(mo))
-  mo_becker <- as.mo(mo, Becker = TRUE)
-  mo_lancefield <- as.mo(mo, Lancefield = TRUE)
-  
-  guideline_coerced <- get_guideline(guideline)
-  if (guideline_coerced != guideline) {
-    message(blue(paste0("Note: Using guideline ", bold(guideline_coerced), " as input for `guideline`.")))
-  }
-
-  new_rsi <- rep(NA_character_, length(x))
-  trans <- AMR::rsi_translation %>%
-    filter(guideline == guideline_coerced & method == method_param) %>%
-    mutate(lookup = paste(mo, ab))
-
-  lookup_mo <- paste(mo, ab)
-  lookup_genus <- paste(mo_genus, ab)
-  lookup_family <- paste(mo_family, ab)
-  lookup_order <- paste(mo_order, ab)
-  lookup_becker <- paste(mo_becker, ab)
-  lookup_lancefield <- paste(mo_lancefield, ab)
-  
-  for (i in seq_len(length(x))) {
-    get_record <- trans %>%
-      filter(lookup %in% c(lookup_mo[i],
-                           lookup_genus[i],
-                           lookup_family[i],
-                           lookup_order[i],
-                           lookup_becker[i],
-                           lookup_lancefield[i])) %>%
-      # be as specific as possible (i.e. prefer species over genus):
-      arrange(desc(nchar(mo))) %>%
-      .[1L, ]
-    
-    if (NROW(get_record) > 0) {
-      if (is.na(x[i])) {
-        new_rsi[i] <- NA_character_
-      } else if (method == "mic") {
-        new_rsi[i] <- case_when(isTRUE(x[i] <= get_record$breakpoint_S) ~ "S",
-                                isTRUE(x[i] >= get_record$breakpoint_R) ~ "R",
-                                !is.na(get_record$breakpoint_S) & !is.na(get_record$breakpoint_R) ~ "I",
-                                TRUE ~ NA_character_)
-      } else if (method == "disk") {
-        new_rsi[i] <- case_when(isTRUE(x[i] >= get_record$breakpoint_S) ~ "S",
-                                isTRUE(x[i] <= get_record$breakpoint_R) ~ "R",
-                                !is.na(get_record$breakpoint_S) & !is.na(get_record$breakpoint_R) ~ "I",
-                                TRUE ~ NA_character_)
-      }
-    }
-  }
-  structure(.Data = factor(new_rsi, levels = c("S", "I", "R"), ordered = TRUE),
-            class =  c("rsi", "ordered", "factor"))
-}
-
-#' @rdname as.rsi
-#' @importFrom crayon red blue bold
-#' @export
-as.rsi.data.frame <- function(x, col_mo = NULL, guideline = "EUCAST", ...) {
-  x <- x
-  
-  ab_cols <- colnames(x)[sapply(x, function(y) is.mic(y) | is.disk(y))]
-  if (length(ab_cols) == 0) {
-    stop("No columns with MIC values or disk zones found in this data set. Use as.mic or as.disk to transform antimicrobial columns.", call. = FALSE)
-  }
-  
-  # try to find columns based on type
-  # -- mo
-  if (is.null(col_mo)) {
-    col_mo <- search_type_in_df(x = x, type = "mo")
-  }
-  if (is.null(col_mo)) {
-    stop("`col_mo` must be set.", call. = FALSE)
-  }
-  
-  guideline_coerced <- get_guideline(guideline)
-  if (guideline_coerced != guideline) {
-    message(blue(paste0("Note: Using guideline ", bold(guideline_coerced), " as input for `guideline`.")))
-  }
-  
-  # transform all MICs
-  ab_cols <- colnames(x)[sapply(x, is.mic)]
-  if (length(ab_cols) > 0) {
-    for (i in seq_len(length(ab_cols))) {
-      ab_col_coerced <- suppressWarnings(as.ab(ab_cols[i]))
-      if (is.na(ab_col_coerced)) {
-        message(red(paste0("Unknown drug: `", bold(ab_cols[i]), "`. Rename this column to a drug name or code, and check the output with as.ab().")))
-        next
-      }
-      message(blue(paste0("Interpreting column `", bold(ab_cols[i]), "` (",
-                          ifelse(ab_col_coerced != ab_cols[i], paste0(ab_col_coerced, ", "), ""),
-                          ab_name(ab_col_coerced, tolower = TRUE), ")...")),
-              appendLF = FALSE)
-      x[, ab_cols[i]] <- exec_as.rsi(method = "mic",
-                                     x = x %>% pull(ab_cols[i]),
-                                     mo = x %>% pull(col_mo),
-                                     ab = ab_col_coerced,
-                                     guideline = guideline_coerced)
-      message(blue(" OK."))
-    }
-  }
-  # transform all disks
-  ab_cols <- colnames(x)[sapply(x, is.disk)]
-  if (length(ab_cols) > 0) {
-    for (i in seq_len(length(ab_cols))) {
-      ab_col_coerced <- suppressWarnings(as.ab(ab_cols[i]))
-      if (is.na(ab_col_coerced)) {
-        message(red(paste0("Unknown drug: `", bold(ab_cols[i]), "`. Rename this column to a drug name or code, and check the output with as.ab().")))
-        next
-      }
-      message(blue(paste0("Interpreting column `", bold(ab_cols[i]), "` (",
-                          ifelse(ab_col_coerced != ab_cols[i], paste0(ab_col_coerced, ", "), ""),
-                          ab_name(ab_col_coerced, tolower = TRUE), ")...")),
-              appendLF = FALSE)
-      x[, ab_cols[i]] <- exec_as.rsi(method = "disk",
-                                     x = x %>% pull(ab_cols[i]),
-                                     mo = x %>% pull(col_mo),
-                                     ab = ab_col_coerced,
-                                     guideline = guideline_coerced)
-      message(blue(" OK."))
-    }
-  }
-  
-  x
-}
-
-#' @rdname as.rsi
-#' @export
-is.rsi <- function(x) {
-  identical(class(x),
-            c("rsi", "ordered", "factor"))
-}
-
-#' @rdname as.rsi
-#' @export
-is.rsi.eligible <- function(x, threshold = 0.05) {
-  if (NCOL(x) > 1) {
-    stop("`x` must be a one-dimensional vector.")
-  }
-  if (any(c("logical",
-            "numeric",
-            "integer",
-            "mo",
-            "Date",
-            "POSIXct",
-            "rsi",
-            "raw",
-            "hms")
-          %in% class(x))) {
-    # no transformation needed
-    FALSE
-  } else {
-    x <- x[!is.na(x) & !is.null(x) & !identical(x, "")]
-    if (length(x) == 0) {
-      return(FALSE)
-    }
-    checked <- suppressWarnings(as.rsi(x))
-    outcome <- sum(is.na(checked)) / length(x)
-    outcome <= threshold
-  }
-}
-
-#' @exportMethod print.rsi
-#' @export
-#' @importFrom dplyr %>%
-#' @noRd
-print.rsi <- function(x, ...) {
-  cat("Class 'rsi'\n")
-  print(as.character(x), quote = FALSE)
-}
-
-#' @exportMethod droplevels.rsi
-#' @export
-#' @noRd
-droplevels.rsi <- function(x, exclude = if (anyNA(levels(x))) NULL else NA, ...) {
-  x <- droplevels.factor(x, exclude = exclude, ...)
-  class(x) <- c("rsi", "ordered", "factor")
-  x
-}
-
-#' @exportMethod summary.rsi
-#' @export
-#' @noRd
-summary.rsi <- function(object, ...) {
-  x <- object
-  c(
-    "Class" = "rsi",
-    "<NA>" = sum(is.na(x)),
-    "Sum S" = sum(x == "S", na.rm = TRUE),
-    "Sum IR" = sum(x %in% c("I", "R"), na.rm = TRUE),
-    "-Sum R" = sum(x == "R", na.rm = TRUE),
-    "-Sum I" = sum(x == "I", na.rm = TRUE)
-  )
-}
-
-#' @exportMethod plot.rsi
-#' @export
-#' @importFrom dplyr %>% group_by summarise filter mutate if_else n_distinct
-#' @importFrom graphics plot text
-#' @noRd
-plot.rsi <- function(x,
-                     lwd = 2,
-                     ylim = NULL,
-                     ylab = "Percentage",
-                     xlab = "Antimicrobial Interpretation",
-                     main = paste("Susceptibility Analysis of", deparse(substitute(x))),
-                     axes = FALSE,
-                     ...) {
-  suppressWarnings(
-    data <- data.frame(x = x,
-                       y = 1,
-                       stringsAsFactors = TRUE) %>%
-      group_by(x) %>%
-      summarise(n = sum(y)) %>%
-      filter(!is.na(x)) %>%
-      mutate(s = round((n / sum(n)) * 100, 1))
-  )
-  if (!"S" %in% data$x) {
-    data <- rbind(data, data.frame(x = "S", n = 0, s = 0))
-  }
-  if (!"I" %in% data$x) {
-    data <- rbind(data, data.frame(x = "I", n = 0, s = 0))
-  }
-  if (!"R" %in% data$x) {
-    data <- rbind(data, data.frame(x = "R", n = 0, s = 0))
-  }
-  
-  data$x <- factor(data$x, levels = c("S", "I", "R"), ordered = TRUE)
-  
-  ymax <- if_else(max(data$s) > 95, 105, 100)
-  
-  plot(x = data$x,
-       y = data$s,
-       lwd = lwd,
-       ylim = c(0, ymax),
-       ylab = ylab,
-       xlab = xlab,
-       main = main,
-       axes = axes,
-       ...)
-  # x axis
-  axis(side = 1, at = 1:n_distinct(data$x), labels = levels(data$x), lwd = 0)
-  # y axis, 0-100%
-  axis(side = 2, at = seq(0, 100, 5))
-  
-  text(x = data$x,
-       y = data$s + 4,
-       labels = paste0(data$s, "% (n = ", data$n, ")"))
-}
-
-
-#' @exportMethod barplot.rsi
-#' @export
-#' @importFrom dplyr %>% group_by summarise
-#' @importFrom graphics barplot axis par
-#' @noRd
-barplot.rsi <- function(height,
-                        col = c("green3", "orange2", "red3"),
-                        xlab = ifelse(beside, "Antimicrobial Interpretation", ""),
-                        main = paste("Susceptibility Analysis of", deparse(substitute(height))),
-                        ylab = "Frequency",
-                        beside = TRUE,
-                        axes = beside,
-                        ...) {
-  
-  if (axes == TRUE) {
-    par(mar =  c(5, 4, 4, 2) + 0.1)
-  } else {
-    par(mar =  c(2, 4, 4, 2) + 0.1)
-  }
-  
-  barplot(as.matrix(table(height)),
-          col = col,
-          xlab = xlab,
-          main = main,
-          ylab = ylab,
-          beside = beside,
-          axes = FALSE,
-          ...)
-  # y axis, 0-100%
-  axis(side = 2, at = seq(0, max(table(height)) + max(table(height)) * 1.1, by = 25))
-  if (axes == TRUE && beside == TRUE) {
-    axis(side = 1, labels = levels(height), at = c(1, 2, 3) + 0.5, lwd = 0)
-  }
-}
-
-#' @importFrom pillar type_sum
-#' @export
-type_sum.rsi <- function(x) {
-  "rsi"
-}
-
-#' @importFrom pillar pillar_shaft
-#' @importFrom crayon bgGreen bgYellow bgRed black white
-#' @export 
-pillar_shaft.rsi <- function(x, ...) {
-  out <- trimws(format(x))
-  out[is.na(x)] <- pillar::style_subtle(" NA")
-  out[x == "S"] <- bgGreen(white(" S "))
-  out[x == "I"] <- bgYellow(black(" I "))
-  out[x == "R"] <- bgRed(white(" R "))
-  pillar::new_pillar_shaft_simple(out, align = "left", width = 3)
-}

R/rsi_calc.R

@@ -1,259 +0,0 @@
-# ==================================================================== #
-# TITLE                                                                #
-# Antimicrobial Resistance (AMR) Analysis                              #
-#                                                                      #
-# SOURCE                                                               #
-# https://gitlab.com/msberends/AMR                                     #
-#                                                                      #
-# LICENCE                                                              #
-# (c) 2019 Berends MS (m.s.berends@umcg.nl), Luz CF (c.f.luz@umcg.nl)  #
-#                                                                      #
-# This R package is free software; you can freely use and distribute   #
-# it for both personal and commercial purposes under the terms of the  #
-# GNU General Public License version 2.0 (GNU GPL-2), as published by  #
-# the Free Software Foundation.                                        #
-#                                                                      #
-# This R package was created for academic research and was publicly    #
-# released in the hope that it will be useful, but it comes WITHOUT    #
-# ANY WARRANTY OR LIABILITY.                                           #
-# Visit our website for more info: https://msberends.gitlab.io/AMR.    #
-# ==================================================================== #
-
-#' @importFrom rlang enquos as_label
-dots2vars <- function(...) {
-  # this function is to give more informative output about 
-  # variable names in count_* and proportion_* functions
-  paste(
-    unlist(
-      lapply(enquos(...),
-             function(x) {
-               l <- as_label(x)
-               if (l != ".") {
-                 l
-               } else {
-                 character(0)
-               }
-             })
-    ),
-    collapse = ", ")
-}
-
-#' @importFrom dplyr %>% pull all_vars any_vars filter_all funs mutate_all
-#' @importFrom cleaner percentage
-rsi_calc <- function(...,
-                     ab_result,
-                     minimum = 0,
-                     as_percent = FALSE,
-                     only_all_tested = FALSE,
-                     only_count = FALSE) {
-  
-  data_vars <- dots2vars(...)
-  
-  if (!is.numeric(minimum)) {
-    stop("`minimum` must be numeric", call. = FALSE)
-  }
-  if (!is.logical(as_percent)) {
-    stop("`as_percent` must be logical", call. = FALSE)
-  }
-  if (!is.logical(only_all_tested)) {
-    stop("`only_all_tested` must be logical", call. = FALSE)
-  }
-  
-  dots_df <- ...elt(1) # it needs this evaluation
-  dots <- base::eval(base::substitute(base::alist(...)))
-  if ("also_single_tested" %in% names(dots)) {
-    stop("`also_single_tested` was replaced by `only_all_tested`. Please read Details in the help page (`?proportion`) as this may have a considerable impact on your analysis.", call. = FALSE)
-  }
-  ndots <- length(dots)
-  
-  if ("data.frame" %in% class(dots_df)) {
-    # data.frame passed with other columns, like: example_isolates %>% proportion_S(amcl, gent)
-    dots <- as.character(dots)
-    dots <- dots[dots != "."]
-    if (length(dots) == 0 | all(dots == "df")) {
-      # for complete data.frames, like example_isolates %>% select(amcl, gent) %>% proportion_S()
-      # and the old rsi function, that has "df" as name of the first parameter
-      x <- dots_df
-    } else {
-      x <- dots_df[, dots]
-    }
-  } else if (ndots == 1) {
-    # only 1 variable passed (can also be data.frame), like: proportion_S(example_isolates$amcl) and example_isolates$amcl %>% proportion_S()
-    x <- dots_df
-  } else {
-    # multiple variables passed without pipe, like: proportion_S(example_isolates$amcl, example_isolates$gent)
-    x <- NULL
-    try(x <- as.data.frame(dots), silent = TRUE)
-    if (is.null(x)) {
-      # support for: with(example_isolates, proportion_S(amcl, gent))
-      x <- as.data.frame(rlang::list2(...))
-    }
-  }
-  
-  if (is.null(x)) {
-    warning("argument is NULL (check if columns exist): returning NA", call. = FALSE)
-    return(NA)
-  }
-  
-  print_warning <- FALSE
-  
-  ab_result <- as.rsi(ab_result)
-  
-  if (is.data.frame(x)) {
-    rsi_integrity_check <- character(0)
-    for (i in seq_len(ncol(x))) {
-      # check integrity of columns: force rsi class
-      if (!is.rsi(x %>% pull(i))) {
-        rsi_integrity_check <- c(rsi_integrity_check, x %>% pull(i) %>% as.character())
-        x[, i] <- suppressWarnings(x %>% pull(i) %>% as.rsi()) # warning will be given later
-        print_warning <- TRUE
-      }
-    }
-    if (length(rsi_integrity_check) > 0) {
-      # this will give a warning for invalid results, of all input columns (so only 1 warning)
-      rsi_integrity_check <- as.rsi(rsi_integrity_check)
-    }
-    
-    if (only_all_tested == TRUE) {
-      # THE NUMBER OF ISOLATES WHERE *ALL* ABx ARE S/I/R
-      x <- apply(X = x %>% mutate_all(as.integer),
-                 MARGIN = 1,
-                 FUN = base::min)
-      numerator <- sum(as.integer(x) %in% as.integer(ab_result), na.rm = TRUE)
-      denominator <- length(x) - sum(is.na(x))
-      
-    } else {
-      # THE NUMBER OF ISOLATES WHERE *ANY* ABx IS S/I/R
-      other_values <- base::setdiff(c(NA, levels(ab_result)), ab_result)
-      other_values_filter <- base::apply(x, 1, function(y) {
-        base::all(y %in% other_values) & base::any(is.na(y))
-      })
-      numerator <- x %>% filter_all(any_vars(. %in% ab_result)) %>% nrow()
-      denominator <- x %>% filter(!other_values_filter) %>% nrow()
-    }
-  } else {
-    # x is not a data.frame
-    if (!is.rsi(x)) {
-      x <- as.rsi(x)
-      print_warning <- TRUE
-    }
-    numerator <- sum(x %in% ab_result, na.rm = TRUE)
-    denominator <- sum(x %in% levels(ab_result), na.rm = TRUE)
-  }
-  
-  if (print_warning == TRUE) {
-    warning("Increase speed by transforming to class `rsi` on beforehand: df %>% mutate_if(is.rsi.eligible, as.rsi)",
-            call. = FALSE)
-  }
-  
-  if (only_count == TRUE) {
-    return(numerator)
-  }
-  
-  if (denominator < minimum) {
-    if (data_vars != "") {
-      data_vars <- paste(" for", data_vars)
-    }
-    warning("Introducing NA: only ", denominator, " results available", data_vars, " (`minimum` was set to ", minimum, ").", call. = FALSE)
-    fraction <- NA
-  } else {
-    fraction <- numerator / denominator
-  }
-  
-  if (as_percent == TRUE) {
-    percentage(fraction, digits = 1)
-  } else {
-    fraction
-  }
-}
-
-#' @importFrom dplyr %>% summarise_if mutate select everything bind_rows arrange
-#' @importFrom tidyr pivot_longer
-rsi_calc_df <- function(type, # "proportion" or "count"
-                        data,
-                        translate_ab = "name",
-                        language = get_locale(),
-                        minimum = 30,
-                        as_percent = FALSE,
-                        combine_SI = TRUE,
-                        combine_IR = FALSE,
-                        combine_SI_missing = FALSE) {
-  
-  if (!"data.frame" %in% class(data)) {
-    stop(paste0("`", type, "_df` must be called on a data.frame"), call. = FALSE)
-  }
-  
-  if (isTRUE(combine_IR) & isTRUE(combine_SI_missing)) {
-    combine_SI <- FALSE
-  }
-  if (isTRUE(combine_SI) & isTRUE(combine_IR)) {
-    stop("either `combine_SI` or `combine_IR` can be TRUE, not both", call. = FALSE)
-  }
-  
-  if (!any(sapply(data, is.rsi), na.rm = TRUE)) {
-    stop("No columns with class 'rsi' found. See ?as.rsi.", call. = FALSE)
-  }
-  
-  if (as.character(translate_ab) %in% c("TRUE", "official")) {
-    translate_ab <- "name"
-  }
-  
-  get_summaryfunction <- function(int, type) {
-    # look for proportion_S, count_S, etc:
-    int_fn <- get(paste0(type, "_", int), envir = asNamespace("AMR"))
-    
-    suppressWarnings(
-      if (type == "proportion") {
-        summ <- summarise_if(.tbl = data,
-                             .predicate = is.rsi,
-                             .funs = int_fn,
-                             minimum = minimum,
-                             as_percent = as_percent)
-      } else if (type == "count") {
-        summ <- summarise_if(.tbl = data,
-                             .predicate = is.rsi,
-                             .funs = int_fn)
-      }
-    )
-    summ %>%
-      mutate(interpretation = int) %>%
-      select(interpretation, everything())
-  }
-  
-  resS <- get_summaryfunction("S", type)
-  resI <- get_summaryfunction("I", type)
-  resR <- get_summaryfunction("R", type)
-  resSI <- get_summaryfunction("SI", type)
-  resIR <- get_summaryfunction("IR", type)
-  data.groups <- group_vars(data)
-  
-  if (isFALSE(combine_SI) & isFALSE(combine_IR)) {
-    res <- bind_rows(resS, resI, resR) %>%
-      mutate(interpretation = factor(interpretation,
-                                     levels = c("S", "I", "R"),
-                                     ordered = TRUE))
-    
-  } else if (isTRUE(combine_IR)) {
-    res <- bind_rows(resS, resIR) %>%
-      mutate(interpretation = factor(interpretation,
-                                     levels = c("S", "IR"),
-                                     ordered = TRUE))
-    
-  } else if (isTRUE(combine_SI)) {
-    res <- bind_rows(resSI, resR) %>%
-      mutate(interpretation = factor(interpretation,
-                                     levels = c("SI", "R"),
-                                     ordered = TRUE))
-  }
-  
-  res <- res %>%
-    pivot_longer(-c(interpretation, data.groups), names_to = "antibiotic") %>% 
-    select(antibiotic, everything()) %>% 
-    arrange(antibiotic, interpretation)
-  
-  if (!translate_ab == FALSE) {
-    res <- res %>% mutate(antibiotic = AMR::ab_property(antibiotic, property = translate_ab, language = language))
-  }
-  
-  as.data.frame(res, stringsAsFactors = FALSE)
-}

R/rsi_df.R

@@ -1,56 +0,0 @@
-# ==================================================================== #
-# TITLE                                                                #
-# Antimicrobial Resistance (AMR) Analysis                              #
-#                                                                      #
-# SOURCE                                                               #
-# https://gitlab.com/msberends/AMR                                     #
-#                                                                      #
-# LICENCE                                                              #
-# (c) 2019 Berends MS (m.s.berends@umcg.nl), Luz CF (c.f.luz@umcg.nl)  #
-#                                                                      #
-# This R package is free software; you can freely use and distribute   #
-# it for both personal and commercial purposes under the terms of the  #
-# GNU General Public License version 2.0 (GNU GPL-2), as published by  #
-# the Free Software Foundation.                                        #
-#                                                                      #
-# This R package was created for academic research and was publicly    #
-# released in the hope that it will be useful, but it comes WITHOUT    #
-# ANY WARRANTY OR LIABILITY.                                           #
-# Visit our website for more info: https://msberends.gitlab.io/AMR.    #
-# ==================================================================== #
-
-#' @rdname proportion 
-#' @export
-rsi_df <- function(data,
-                   translate_ab = "name",
-                   language = get_locale(),
-                   minimum = 30,
-                   as_percent = FALSE,
-                   combine_SI = TRUE,
-                   combine_IR = FALSE) {
-  
-  proportions <- rsi_calc_df(type = "proportion",
-                             data = data,
-                             translate_ab = translate_ab,
-                             language = language,
-                             minimum = minimum,
-                             as_percent = as_percent,
-                             combine_SI = combine_SI,
-                             combine_IR = combine_IR,
-                             combine_SI_missing = missing(combine_SI))
-  
-  counts <- rsi_calc_df(type = "count",
-                        data = data,
-                        translate_ab = FALSE,
-                        language = "en",
-                        minimum = minimum,
-                        as_percent = as_percent,
-                        combine_SI = combine_SI,
-                        combine_IR = combine_IR,
-                        combine_SI_missing = missing(combine_SI))
-  
-  data.frame(proportions,
-             isolates = counts$value,
-             stringsAsFactors = FALSE)
-  
-}

R/skewness.R

@@ -1,62 +0,0 @@
-# ==================================================================== #
-# TITLE                                                                #
-# Antimicrobial Resistance (AMR) Analysis                              #
-#                                                                      #
-# SOURCE                                                               #
-# https://gitlab.com/msberends/AMR                                     #
-#                                                                      #
-# LICENCE                                                              #
-# (c) 2019 Berends MS (m.s.berends@umcg.nl), Luz CF (c.f.luz@umcg.nl)  #
-#                                                                      #
-# This R package is free software; you can freely use and distribute   #
-# it for both personal and commercial purposes under the terms of the  #
-# GNU General Public License version 2.0 (GNU GPL-2), as published by  #
-# the Free Software Foundation.                                        #
-#                                                                      #
-# This R package was created for academic research and was publicly    #
-# released in the hope that it will be useful, but it comes WITHOUT    #
-# ANY WARRANTY OR LIABILITY.                                           #
-# Visit our website for more info: https://msberends.gitlab.io/AMR.    #
-# ==================================================================== #
-
-#' Skewness of the sample
-#'
-#' @description Skewness is a measure of the asymmetry of the probability distribution of a real-valued random variable about its mean.
-#'
-#' When negative: the left tail is longer; the mass of the distribution is concentrated on the right of the figure. When positive: the right tail is longer; the mass of the distribution is concentrated on the left of the figure.
-#' @param x a vector of values, a [`matrix`] or a [`data.frame`]
-#' @param na.rm a logical value indicating whether `NA` values should be stripped before the computation proceeds.
-#' @exportMethod skewness
-#' @seealso [kurtosis()]
-#' @rdname skewness
-#' @inheritSection AMR Read more on our website!
-#' @export
-skewness <- function(x, na.rm = FALSE) {
-  UseMethod("skewness")
-}
-
-#' @exportMethod skewness.default
-#' @rdname skewness
-#' @export
-skewness.default <- function(x, na.rm = FALSE) {
-  x <- as.vector(x)
-  if (na.rm == TRUE) {
-    x <- x[!is.na(x)]
-  }
-  n <- length(x)
-  (base::sum((x - base::mean(x))^3) / n) / (base::sum((x - base::mean(x)) ^ 2) / n) ^ (3 / 2)
-}
-
-#' @exportMethod skewness.matrix
-#' @rdname skewness
-#' @export
-skewness.matrix <- function(x, na.rm = FALSE) {
-  base::apply(x, 2, skewness.default, na.rm = na.rm)
-}
-
-#' @exportMethod skewness.data.frame
-#' @rdname skewness
-#' @export
-skewness.data.frame <- function(x, na.rm = FALSE) {
-  base::sapply(x, skewness.default, na.rm = na.rm)
-}

R/translate.R

@@ -1,148 +0,0 @@
-# ==================================================================== #
-# TITLE                                                                #
-# Antimicrobial Resistance (AMR) Analysis                              #
-#                                                                      #
-# SOURCE                                                               #
-# https://gitlab.com/msberends/AMR                                     #
-#                                                                      #
-# LICENCE                                                              #
-# (c) 2019 Berends MS (m.s.berends@umcg.nl), Luz CF (c.f.luz@umcg.nl)  #
-#                                                                      #
-# This R package is free software; you can freely use and distribute   #
-# it for both personal and commercial purposes under the terms of the  #
-# GNU General Public License version 2.0 (GNU GPL-2), as published by  #
-# the Free Software Foundation.                                        #
-#                                                                      #
-# This R package was created for academic research and was publicly    #
-# released in the hope that it will be useful, but it comes WITHOUT    #
-# ANY WARRANTY OR LIABILITY.                                           #
-# Visit our website for more info: https://msberends.gitlab.io/AMR.    #
-# ==================================================================== #
-
-#' Translate strings from AMR package
-#'
-#' For language-dependent output of AMR functions, like [mo_name()], [mo_type()] and [ab_name()].
-#' @details Strings will be translated to foreign languages if they are defined in a local translation file. Additions to this file can be suggested at our repository. The file can be found here: <https://gitlab.com/msberends/AMR/blob/master/data-raw/translations.tsv>.
-#'
-#' Currently supported languages can be found if running: `unique(AMR:::translations_file$lang)`.
-#'
-#' Please suggest your own translations [by creating a new issue on our repository](https://gitlab.com/msberends/AMR/issues/new?issue[title]=Translation\%20suggestion).
-#'
-#' This file will be read by all functions where a translated output can be desired, like all [mo_property()] functions ([mo_fullname()], [mo_type()], etc.).
-#'
-#' The system language will be used at default, if that language is supported. The system language can be overwritten with `Sys.setenv(AMR_locale = yourlanguage)`.
-#' @inheritSection AMR Read more on our website!
-#' @rdname translate
-#' @name translate
-#' @export
-#' @examples
-#' # The 'language' parameter of below functions
-#' # will be set automatically to your system language
-#' # with get_locale()
-#'
-#' # English
-#' mo_name("CoNS", language = "en")
-#' #> "Coagulase-negative Staphylococcus (CoNS)"
-#'
-#' # German
-#' mo_name("CoNS", language = "de")
-#' #> "Koagulase-negative Staphylococcus (KNS)"
-#'
-#' # Dutch
-#' mo_name("CoNS", language = "nl")
-#' #> "Coagulase-negatieve Staphylococcus (CNS)"
-#'
-#' # Spanish
-#' mo_name("CoNS", language = "es")
-#' #> "Staphylococcus coagulasa negativo (SCN)"
-#'
-#' # Italian
-#' mo_name("CoNS", language = "it")
-#' #> "Staphylococcus negativo coagulasi (CoNS)"
-#'
-#' # Portuguese
-#' mo_name("CoNS", language = "pt")
-#' #> "Staphylococcus coagulase negativo (CoNS)"
-get_locale <- function() {
-  if (!is.null(getOption("AMR_locale", default = NULL))) {
-    return(getOption("AMR_locale"))
-  }
-
-  lang <- Sys.getlocale("LC_COLLATE")
-  
-  # Check the locale settings for a start with one of these languages:
-  
-  # grepl() with ignore.case = FALSE is faster than %like%
-  
-  if (grepl("^(English|en_|EN_)", lang, ignore.case = FALSE)) {
-    # as first option to optimise speed
-    "en"
-  } else if (grepl("^(German|Deutsch|de_|DE_)", lang, ignore.case = FALSE)) {
-    "de"
-  } else if (grepl("^(Dutch|Nederlands|nl_|NL_)", lang, ignore.case = FALSE)) {
-    "nl"
-  } else if (grepl("^(Spanish|Espa.ol|es_|ES_)", lang, ignore.case = FALSE)) {
-    "es"
-  } else if (grepl("^(Italian|Italiano|it_|IT_)", lang, ignore.case = FALSE)) {
-    "it"
-  } else if (grepl("^(French|Fran.ais|fr_|FR_)", lang, ignore.case = FALSE)) {
-    "fr"
-  } else if (grepl("^(Portuguese|Portugu.s|pt_|PT_)", lang, ignore.case = FALSE)) {
-    "pt"
-  } else {
-    # other language -> set to English
-    "en"
-  }
-}
-
-# translate strings based on inst/translations.tsv
-#' @importFrom dplyr %>% filter
-translate_AMR <- function(from, language = get_locale(), only_unknown = FALSE) {
-
-  if (is.null(language)) {
-    return(from)
-  }
-  if (language %in% c("en", "", NA)) {
-    return(from)
-  }
-  
-  df_trans <- translations_file # internal data file
-  
-  if (!language %in% df_trans$lang) {
-    stop("Unsupported language: '", language, "' - use one of: ",
-         paste0("'", sort(unique(df_trans$lang)), "'", collapse = ", "),
-         call. = FALSE)
-  }
-  
-  df_trans <- df_trans %>% filter(lang == language)
-  if (only_unknown == TRUE) {
-    df_trans <- df_trans %>% filter(pattern %like% "unknown")
-  }
-  
-  # default case sensitive if value if 'ignore.case' is missing:
-  df_trans$ignore.case[is.na(df_trans$ignore.case)] <- FALSE
-  # default not using regular expressions (fixed = TRUE) if 'fixed' is missing:
-  df_trans$fixed[is.na(df_trans$fixed)] <- TRUE
-  
-  # check if text to look for is in one of the patterns
-  any_form_in_patterns <- tryCatch(any(from %like% paste0("(", paste(df_trans$pattern, collapse = "|"), ")")),
-                                   error = function(e) {
-                                     warning("Translation not possible. Please open an issue on GitLab (https://gitlab.com/msberends/AMR/issues) or GitHub (https://github.com/msberends/AMR/issues).", call. = FALSE)
-                                     return(FALSE)
-                                   })
-  if (NROW(df_trans) == 0 | !any_form_in_patterns) {
-    return(from)
-  }
-  
-  for (i in seq_len(nrow(df_trans))) {
-    from <- gsub(x = from,
-                 pattern = df_trans$pattern[i],
-                 replacement = df_trans$replacement[i],
-                 fixed = df_trans$fixed[i],
-                 ignore.case = df_trans$ignore.case[i])
-  }
-  
-  # force UTF-8 for diacritics
-  base::enc2utf8(from)
-  
-}

R/whocc.R

@@ -1,42 +0,0 @@
-# ==================================================================== #
-# TITLE                                                                #
-# Antimicrobial Resistance (AMR) Analysis                              #
-#                                                                      #
-# SOURCE                                                               #
-# https://gitlab.com/msberends/AMR                                     #
-#                                                                      #
-# LICENCE                                                              #
-# (c) 2019 Berends MS (m.s.berends@umcg.nl), Luz CF (c.f.luz@umcg.nl)  #
-#                                                                      #
-# This R package is free software; you can freely use and distribute   #
-# it for both personal and commercial purposes under the terms of the  #
-# GNU General Public License version 2.0 (GNU GPL-2), as published by  #
-# the Free Software Foundation.                                        #
-#                                                                      #
-# This R package was created for academic research and was publicly    #
-# released in the hope that it will be useful, but it comes WITHOUT    #
-# ANY WARRANTY OR LIABILITY.                                           #
-# Visit our website for more info: https://msberends.gitlab.io/AMR.    #
-# ==================================================================== #
-
-#' WHOCC: WHO Collaborating Centre for Drug Statistics Methodology
-#'
-#' All antimicrobial drugs and their official names, ATC codes, ATC groups and defined daily dose (DDD) are included in this package, using the WHO Collaborating Centre for Drug Statistics Methodology.
-#' @section WHOCC:
-#' \if{html}{\figure{logo_who.png}{options: height=60px style=margin-bottom:5px} \cr}
-#' This package contains **all ~550 antibiotic, antimycotic and antiviral drugs** and their Anatomical Therapeutic Chemical (ATC) codes, ATC groups and Defined Daily Dose (DDD) from the World Health Organization Collaborating Centre for Drug Statistics Methodology (WHOCC, <https://www.whocc.no>) and the Pharmaceuticals Community Register of the European Commission (<http://ec.europa.eu/health/documents/community-register/html/atc.htm>). 
-#'
-#' These have become the gold standard for international drug utilisation monitoring and research.
-#'
-#' The WHOCC is located in Oslo at the Norwegian Institute of Public Health and funded by the Norwegian government. The European Commission is the executive of the European Union and promotes its general interest.
-#' 
-#' **NOTE: The WHOCC copyright does not allow use for commercial purposes, unlike any other info from this package.** See <https://www.whocc.no/copyright_disclaimer/.>
-#' @inheritSection AMR Read more on our website!
-#' @name WHOCC
-#' @rdname WHOCC
-#' @examples
-#' as.ab("meropenem")
-#' ab_name("J01DH02")
-#'
-#' ab_tradenames("flucloxacillin")
-NULL

R/zzz.R

@@ -1,273 +0,0 @@
-# ==================================================================== #
-# TITLE                                                                #
-# Antimicrobial Resistance (AMR) Analysis                              #
-#                                                                      #
-# SOURCE                                                               #
-# https://gitlab.com/msberends/AMR                                     #
-#                                                                      #
-# LICENCE                                                              #
-# (c) 2019 Berends MS (m.s.berends@umcg.nl), Luz CF (c.f.luz@umcg.nl)  #
-#                                                                      #
-# This R package is free software; you can freely use and distribute   #
-# it for both personal and commercial purposes under the terms of the  #
-# GNU General Public License version 2.0 (GNU GPL-2), as published by  #
-# the Free Software Foundation.                                        #
-#                                                                      #
-# This R package was created for academic research and was publicly    #
-# released in the hope that it will be useful, but it comes WITHOUT    #
-# ANY WARRANTY OR LIABILITY.                                           #
-# Visit our website for more info: https://msberends.gitlab.io/AMR.    #
-# ==================================================================== #
-
-#' @importFrom data.table as.data.table setkey
-.onLoad <- function(libname, pkgname) {
-  # get new functions not available in older versions of R
-  backports::import(pkgname)
-
-  # register data
-  microorganisms.oldDT <- as.data.table(AMR::microorganisms.old)
-  # for fullname_lower: keep only dots, letters, numbers, slashes, spaces and dashes
-  microorganisms.oldDT$fullname_lower <- gsub("[^.a-z0-9/ \\-]+", "", tolower(microorganisms.oldDT$fullname))
-  setkey(microorganisms.oldDT, prevalence, fullname)
-
-  assign(x = "microorganismsDT",
-         value = make_DT(),
-         envir = asNamespace("AMR"))
-
-  assign(x = "microorganisms.oldDT",
-         value = microorganisms.oldDT,
-         envir = asNamespace("AMR"))
-
-  assign(x = "mo_codes_v0.5.0",
-         value = make_trans_tbl(),
-         envir = asNamespace("AMR"))
-
-}
-
-# maybe add survey later: "https://www.surveymonkey.com/r/AMR_for_R"
-
-#' @importFrom data.table as.data.table setkey
-#' @importFrom dplyr %>% mutate case_when
-make_DT <- function() {
-  microorganismsDT <- AMR::microorganisms %>% 
-    mutate(kingdom_index = case_when(kingdom == "Bacteria" ~ 1,
-                                     kingdom == "Fungi" ~ 2,
-                                     kingdom == "Protozoa" ~ 3,
-                                     kingdom == "Archaea" ~ 4,
-                                     TRUE ~ 99),
-           # for fullname_lower: keep only dots, letters,
-           # numbers, slashes, spaces and dashes
-           fullname_lower = gsub("[^.a-z0-9/ \\-]+", "",
-                                 # use this paste instead of `fullname` to
-                                 # work with Viridans Group Streptococci, etc.
-                                 tolower(trimws(ifelse(genus == "",
-                                                       fullname,
-                                                       paste(genus, species, subspecies)))))) %>% 
-    as.data.table()
-  
-  # so arrange data on prevalence first, then kingdom, then full name
-  setkey(microorganismsDT,
-         prevalence,
-         kingdom_index,
-         fullname_lower)
-  microorganismsDT
-}
-
-make_trans_tbl <- function() {
-  # conversion of old MO codes from v0.5.0 (ITIS) to later versions (Catalogue of Life)
-  c(B_ACHRMB = "B_ACHRM", B_ANNMA = "B_ACTNS", B_ACLLS = "B_ALCYC",
-    B_AHNGM = "B_ARCHN", B_ARMTM = "B_ARMTMN", B_ARTHR = "B_ARTHRB", B_ARTHRS = "B_ARTHR",
-    B_APHLS = "B_AZRHZP", B_BRCHA = "B_BRCHY", B_BCTRM = "B_BRVBCT",
-    B_CLRBCT = "B_CLRBC", B_CTRDM = "B_CLSTR", B_CPRMM = "B_CYLND",
-    B_DLCLN = "B_DPLCL", B_DMCLM = "B_DSLFT", B_DSLFVB = "B_DSLFV",
-    B_FCTRM = "B_FSBCT", B_GNRLA = "B_GRDNR", B_HNRBM = "B_HLNRB",
-    B_HPHGA = "B_HNPHGA", B_HCCCS = "B_HYDRC", B_MCRCLS = "B_MCRCL",
-    B_MTHYLS = "B_MLSMA", B_MARCLS = "B_MRCLS", B_MGCLS = "B_MSTGC",
-    B_MCLLA = "B_MTHYLC", B_MYCPLS = "B_MYCPL", B_NBCTR = "B_NTRBC",
-    B_OCLLS = "B_OCNBC", B_PTHRX = "B_PLNKT", B_PCCCS = "B_PRCHL",
-    B_PSPHN = "B_PRPHY", B_PDMNS = "B_PSDMN", B_SCCHRP = "B_SCCHR",
-    B_SRBCTR = "B_SHRBCTR", B_STRPTC = "B_STRPT", B_SHMNS = "B_SYNTR",
-    B_TRBCTR = "B_THRMN", P_ALBMN = "C_ABMNA", F_ACHLY = "C_ACHLY",
-    P_ACINT = "C_ACINT", P_ARTCL = "C_ACLNA", P_ACRVL = "C_ACRVL",
-    P_ADRCT = "C_ADRCT", P_AMPHS = "C_AHSRS", F_ALBUG = "C_ALBUG",
-    P_ALCNT = "C_ALCNT", P_ALFRD = "C_ALFRD", P_ALLGR = "C_ALLGR",
-    P_AMPHL = "C_ALPTS", F_ALTHR = "C_ALTHR", P_AMLLA = "C_AMLLA",
-    P_ANMLN = "C_AMLNA", P_AMMBC = "C_AMMBC", P_AMMDS = "C_AMMDS",
-    P_AMMLG = "C_AMMLG", P_AMMMR = "C_AMMMR", P_AMMMS = "C_AMMMS",
-    P_AMMON = "C_AMMON", P_AMMSC = "C_AMMSC", P_AMMSP = "C_AMMSP",
-    P_AMMST = "C_AMMST", P_AMMTM = "C_AMMTM", F_AMYCS = "C_AMYCS",
-    P_ANARM = "C_ANARM", P_ANGLD = "C_ANGLD", P_ANGLG = "C_ANGLG",
-    P_ANNLC = "C_ANNLC", F_ANSLP = "C_ANSLP", F_APDCH = "C_APDCH",
-    F_APHND = "C_APHND", F_APLNC = "C_APLNC", F_AQLND = "C_AQLND",
-    P_ARCHS = "C_ARCHAS", P_ASTRN = "C_ARNNN", P_ARNPR = "C_ARNPR",
-    F_ARSPR = "C_ARSPR", P_ARTST = "C_ARTSTR", P_AMPHC = "C_ARYNA",
-    P_ASCHM = "C_ASCHM", P_ASPDS = "C_ASPDS", P_ASTCL = "C_ASTCL",
-    P_ASTRG = "C_ASTRGR", P_ASTRM = "C_ASTRMM", P_ASTRR = "C_ASTRR",
-    P_ASTRT = "C_ASTRTR", F_ATKNS = "C_ATKNS", F_AYLLA = "C_AYLLA",
-    P_BAGGN = "C_BAGGN", P_BCCLL = "C_BCCLL", P_BDLLD = "C_BDLLD",
-    P_BGNRN = "C_BGNRN", P_BLCLN = "C_BLCLN", P_BLMND = "C_BLMND",
-    P_BLMNL = "C_BLMNL", P_BLPHR = "C_BLPHR", P_BLVNT = "C_BLVNT",
-    P_BOLVN = "C_BOLVN", P_BORLS = "C_BORLS", P_BRNNM = "C_BRNNM",
-    P_BRSLN = "C_BRSLN", P_BRSRD = "C_BRSRD", F_BRVLG = "C_BRVLG",
-    F_BNLLA = "C_BRVLGN", P_BSCCM = "C_BSCCM", F_BSDPH = "C_BSDPH",
-    P_BTHYS = "C_BTHYS", P_BTLLN = "C_BTLLN", P_BULMN = "C_BULMN",
-    P_CCLDM = "C_CCLDM", P_CDNLL = "C_CDNLL", P_CLPSS = "C_CDNLLP",
-    P_CHLDN = "C_CHLDNL", P_CHLST = "C_CHLST", P_CHNLM = "C_CHNLM",
-    P_CHRYS = "C_CHRYSL", P_CHTSP = "C_CHTSP", P_CBCDS = "C_CIBCDS",
-    P_CLCRN = "C_CLCRN", P_CLMNA = "C_CLMNA", P_CLPDM = "C_CLPDM",
-    P_CLPHR = "C_CLPHRY", P_CLVLN = "C_CLVLN", P_CMPNL = "C_CMPNL",
-    P_CNCRS = "C_CNCRS", P_CNTCH = "C_CNTCH", F_CNTRM = "C_CNTRMY",
-    P_COLPD = "C_COLPD", P_COLPS = "C_COLPS", P_CPRDS = "C_CPRDS",
-    P_CRNSP = "C_CPRMA", P_CRBNL = "C_CRBNL", P_CRBRB = "C_CRBRB",
-    P_CRBRG = "C_CRBRG", P_CRBRS = "C_CRBRS", P_CRCHS = "C_CRCHS",
-    P_CRCLC = "C_CRCLC", P_CRNLC = "C_CRNLC", P_CRNTH = "C_CRNTH",
-    P_CRPNT = "C_CRPNT", P_CRSTG = "C_CRSTG", P_CRTHN = "C_CRTHN",
-    P_CRTRN = "C_CRTRN", P_CYMBL = "C_CRTTA", P_CRYPT = "C_CRYPT",
-    P_CSHMN = "C_CSHMNL", P_CSSDL = "C_CSSDL", P_CLNDS = "C_CSSDLN",
-    P_CHRNA = "C_CTHRN", P_CTPSS = "C_CTPSS", P_CUNLN = "C_CUNLN",
-    P_CYLND = "C_CVLNA", P_CYCLC = "C_CYCLCB", P_CDNTA = "C_CYCLD",
-    P_CYCLG = "C_CYCLG", P_CYCLM = "C_CYCLM", P_CYRTL = "C_CYRTL",
-    P_CYSTM = "C_CYSTM", P_DCHLM = "C_DCHLM", P_DCRBS = "C_DCRBS",
-    P_DCTYC = "C_DCTYC", P_DIDNM = "C_DIDNM", P_DLPTS = "C_DLPTS",
-    P_DNTLN = "C_DNTLN", P_DNTST = "C_DNTST", P_DORTH = "C_DORTH",
-    P_DCTYP = "C_DPHMS", F_DPLCY = "C_DPLCY", P_DNDRT = "C_DRTNA",
-    P_DSCMM = "C_DSCMM", P_DSCRB = "C_DSCRB", P_DSCRN = "C_DSCRN",
-    P_DSCSP = "C_DSCSP", P_DSNBR = "C_DSNBR", P_DYCBC = "C_DYCBC",
-    F_DCTYC = "C_DYCHS", F_ECTRG = "C_ECTRG", B_EDWRD = "C_EDWRD",
-    P_EGGRL = "C_EGGRL", P_EHLYS = "C_EHLYS", P_EHRNB = "C_EHRNB",
-    P_ELPHD = "C_ELPHD", P_ENCHL = "C_ELYDM", P_EPHDM = "C_EPHDM",
-    P_EPLTS = "C_EPLTS", P_EPLXL = "C_EPLXL", P_EPNDL = "C_EPNDL",
-    P_EPNDS = "C_EPNDS", P_ENLLA = "C_EPSTM", P_EPSTY = "C_EPSTY",
-    F_ERYCH = "C_ERYCH", F_ESMDM = "C_ESMDM", P_ESSYR = "C_ESSYR",
-    P_FSCHR = "C_FHRNA", P_FLRLS = "C_FLRLS", P_FLNTN = "C_FNTNA",
-    P_FRNDC = "C_FRNDC", P_FRNTN = "C_FRNTN", P_FRSNK = "C_FRSNK",
-    P_FNLLA = "C_FSCHRN", P_FSSRN = "C_FSSRN", P_FVCSS = "C_FVCSS",
-    P_GDRYN = "C_GDRYN", F_GELGN = "C_GELGN", P_GERDA = "C_GERDA",
-    P_GLACM = "C_GLACM", P_GLBBL = "C_GLBBL", P_GLBGR = "C_GLBGR",
-    P_GLBLN = "C_GLBLN", P_GRTLA = "C_GLBRT", P_GLBTX = "C_GLBTX",
-    P_GLLNA = "C_GLLNA", P_GLMSP = "C_GLMSP", P_GLNDL = "C_GLNDL",
-    F_GNMCH = "C_GNMCH", P_GOSLL = "C_GOSLL", P_GRNDS = "C_GRNDS",
-    P_GRNTA = "C_GRNTA", P_GLBRT = "C_GTLLA", P_GTTLN = "C_GTTLN",
-    P_GVLNP = "C_GVLNP", P_GYPSN = "C_GYPSN", P_GYRDN = "C_GYRDN",
-    P_HALTR = "C_HALTR", P_HANZW = "C_HANZW", P_HAURN = "C_HAURN",
-    P_HELNN = "C_HELNN", P_HLPHR = "C_HHRYA", P_HLNTA = "C_HLNTA",
-    F_HLPHT = "C_HLPHT", P_HLSTC = "C_HLSTC", P_HMSPH = "C_HMSPH",
-    P_HMTRM = "C_HMTRM", P_HPKNS = "C_HPKNS", P_HPLPH = "C_HPLPH",
-    P_HPPCR = "C_HPPCR", P_HNLLA = "C_HPPCRP", P_HRMSN = "C_HRMSN",
-    P_HRNLL = "C_HRNLL", F_HRPCH = "C_HRPCH", P_HSTGR = "C_HSTGR",
-    P_HSTTL = "C_HSTTL", P_HTRST = "C_HTGNA", P_HTRLL = "C_HTRLL",
-    P_HTRPH = "C_HTRPH", F_HYPHC = "C_HYPHC", P_HYPRM = "C_HYPRM",
-    P_INTRN = "C_INTRN", P_IRIDI = "C_IRIDI", P_ISLND = "C_ISLND",
-    P_JCLLL = "C_JCLLL", P_KHLLL = "C_KHLLL", P_KRNPS = "C_KRNPS",
-    P_KRRRL = "C_KRRRL", P_LABOE = "C_LABOE", P_LAGEN = "C_LAGEN",
-    P_LBSLL = "C_LBSLL", F_LTHLA = "C_LBYRN", P_LCRYM = "C_LCRYM",
-    P_LEMBS = "C_LEMBS", F_LGNDM = "C_LGNDM", P_LGNMM = "C_LGNMM",
-    P_LGNPH = "C_LGNPHR", F_LGNSM = "C_LGNSM", P_LGYNP = "C_LGYNP",
-    P_LITTB = "C_LITTB", P_LITUL = "C_LITUL", P_LMBDN = "C_LMBDN",
-    P_LMRCK = "C_LMRCK", F_LBYRN = "C_LMYXA", P_LNGLN = "C_LNGLN",
-    P_LNTCL = "C_LNTCL", P_LOXDS = "C_LOXDS", F_LPTLG = "C_LPTLG",
-    F_LNLLA = "C_LPTLGN", F_LPTMT = "C_LPTMT", P_LRYNG = "C_LRYNG",
-    P_LTCRN = "C_LTCRN", P_LTHPL = "C_LTHPL", P_LTNTS = "C_LTNTS",
-    F_LTRST = "C_LTRST", P_LXPHY = "C_LXPHY", P_MCRTH = "C_MCRTH",
-    P_MELNS = "C_MELNS", P_MSDNM = "C_MESDNM", P_METPS = "C_METPS",
-    P_MIMSN = "C_MIMSN", P_MINCN = "C_MINCN", P_MLLNL = "C_MLLNL",
-    P_MLMMN = "C_MLMMN", F_MNDNL = "C_MNDNL", P_MNLYS = "C_MNLYS",
-    P_MNPSS = "C_MNPSS", P_MRGNL = "C_MRGNL", P_MRGNP = "C_MRGNP",
-    P_MRSPL = "C_MRSPL", P_MRTNT = "C_MRTNT", P_MSSLN = "C_MSSLN",
-    P_MSSSS = "C_MSSSS", P_MTCNT = "C_MTCNT", P_MYCHS = "C_MYCHS",
-    P_MYSCH = "C_MYSCH", F_MYZCY = "C_MYZCY", P_NASSL = "C_NASSL",
-    P_NBCLN = "C_NBCLN", P_NBCLR = "C_NBCLR", P_NCNRB = "C_NCNRB",
-    P_NDBCL = "C_NDBCL", P_NRLLA = "C_NDBCLR", P_NMMLC = "C_NMMLC",
-    F_NMTPH = "C_NMTPH", P_NNNLL = "C_NNNLL", P_NODSR = "C_NODSR",
-    P_NONIN = "C_NONIN", P_NOURI = "C_NOURI", P_OCLNA = "C_OCLNA",
-    P_OGLNA = "C_OGLNA", P_OPHTH = "C_OLMDM", F_OLPDP = "C_OLPDP",
-    P_ONYCH = "C_OMPSS", P_OOLIN = "C_OOLIN", P_OPRCL = "C_OPRCL",
-    P_ORBLN = "C_ORBLN", F_ORCAD = "C_ORCAD", P_ORDRS = "C_ORDRS",
-    P_OPHRY = "C_ORYDM", P_OSNGL = "C_OSNGL", P_OXYTR = "C_OXYTR",
-    P_PARRN = "C_PARRN", P_PATRS = "C_PATRS", P_PAVNN = "C_PAVNN",
-    P_PTYCH = "C_PCYLS", P_PDPHR = "C_PDPHR", P_PELSN = "C_PELSN",
-    F_PHGMY = "C_PHGMY", F_PSDSP = "C_PHRTA", P_PHRYG = "C_PHRYG",
-    P_PHYSL = "C_PHYSL", F_PHYTP = "C_PHYTP", P_PLACS = "C_PLACS",
-    P_PLCPS = "C_PLCPS", P_PLCPSL = "C_PLCPSL", P_PLCTN = "C_PLCTN",
-    P_PLGPH = "C_PLGPH", B_PLGTH = "C_PLGTH", P_PLMRN = "C_PLMRN",
-    P_PLNCT = "C_PLNCT", P_PLNDSC = "C_PLNDSC", P_PLNGY = "C_PLNGY",
-    P_PLNRBL = "C_PLNLLA", P_PLNLN = "C_PLNLN", P_PLNLR = "C_PLNLR",
-    P_PLNRB = "C_PLNRB", P_PLNSP = "C_PLNSPR", P_PLRNM = "C_PLRNM",
-    P_PLRST = "C_PLRST", P_PLRTR = "C_PLRTR", F_PLSMD = "C_PLSMD",
-    P_PLTYC = "C_PLTYC", P_PSDBL = "C_PLVNA", P_PLYMR = "C_PLYMR",
-    P_PLTYN = "C_PNMTM", P_PNRPL = "C_PNRPL", F_PNTSM = "C_PNTSM",
-    P_PRCNT = "C_PRCNT", P_PRFSS = "C_PRFSS", P_PRMCM = "C_PRMCUM",
-    F_PRNSP = "C_PRNSP", P_PRPND = "C_PRPND", P_PRPYX = "C_PRPYX",
-    P_PRRDN = "C_PRRDN", P_PSDDF = "C_PSDDF", P_PSDMC = "C_PSDMC",
-    P_PSDND = "C_PSDND", P_PSDNN = "C_PSDNN", P_PSDPL = "C_PSDPLY",
-    P_PSMMS = "C_PSMMS", P_PTLLN = "C_PTLLN", P_PTLLND = "C_PTLLND",
-    F_PTRSN = "C_PTRSN", P_PULLN = "C_PULLN", P_PUTLN = "C_PUTLN",
-    P_PRTTR = "C_PYMNA", P_PYRGL = "C_PYRGL", P_PYRGO = "C_PYRGO",
-    P_PYRLN = "C_PYRLN", F_PYTHM = "C_PYTHIM", F_PYTHL = "C_PYTHL",
-    P_PYXCL = "C_PYXCL", P_QNQLC = "C_QNQLC", P_RAMLN = "C_RAMLN",
-    P_RBRTN = "C_RBRTN", P_RCRVD = "C_RCRVD", P_RCTBL = "C_RCTBL",
-    P_RCTCB = "C_RCTCB", P_RCTGL = "C_RCTGL", P_RCTVG = "C_RCTVG",
-    P_RDGDR = "C_RDGDR", P_REMNC = "C_REMNC", P_REPHX = "C_REPHX",
-    P_RHBDM = "C_RHBDMM", F_RHBDS = "C_RHBDSP", P_RHPDD = "C_RHPDD",
-    F_RHPDM = "C_RHPDM", F_RHZDMY = "C_RHZDM", P_RHZMM = "C_RHZMM",
-    P_RIVRN = "C_RIVRN", P_ROSLN = "C_ROSLN", P_ROTAL = "C_ROTAL",
-    P_RPHDP = "C_RPHDP", P_RPRTN = "C_RPRTN", P_RSSLL = "C_RSSLL",
-    P_RTLMM = "C_RTLMM", P_RTYLA = "C_RTYLA", P_RUGID = "C_RUGID",
-    F_RZLLP = "C_RZLLP", P_SAGRN = "C_SAGRN", P_SCCMM = "C_SCCMM",
-    P_SCCRH = "C_SCCRH", P_SCHLM = "C_SCHLM", F_SCLRS = "C_SCLRS",
-    P_SCTLR = "C_SCTLR", P_SEBRK = "C_SEBRK", P_SGMLN = "C_SGMLN",
-    P_SGMLP = "C_SGMLP", P_SGMMR = "C_SGMMR", P_SGMVR = "C_SGMVR",
-    F_SMMRS = "C_SMMRS", P_SNNDS = "C_SNNDS", P_SORTS = "C_SORTS",
-    P_SPHGN = "C_SPHGN", P_SPHNN = "C_SPHNN", P_SNLLA = "C_SPHNNL",
-    P_SPHTR = "C_SPHTR", P_SPHTX = "C_SPHTX", P_SPHVG = "C_SPHVG",
-    P_SPRDT = "C_SPRDT", P_SPRLC = "C_SPRLC", F_SPRLG = "C_SPRLG",
-    P_SPRLL = "C_SPRLL", F_SPRMY = "C_SPRMY", P_SPRPL = "C_SPRPL",
-    P_SPRSG = "C_SPRSG", P_SPRST = "C_SPRST", P_SPHNP = "C_SPRTA",
-    P_SPRZN = "C_SPRZN", P_SPHRG = "C_SPSNA", P_STHDM = "C_SPTHD",
-    P_SRCNR = "C_SRCNR", F_SRLPD = "C_SRLPD", F_SPNGS = "C_SSPRA",
-    F_STEIN = "C_STEIN", P_SPTHD = "C_STHDDS", P_STHRP = "C_STHRP",
-    P_STNFR = "C_STNFR", P_STNSM = "C_STNSM", P_STNTR = "C_STNTR",
-    P_STRBL = "C_STRBL", P_STRMB = "C_STRMB", P_STTSN = "C_STTSN",
-    P_STYLN = "C_SYCHA", F_SCHZC = "C_SYTRM", P_TBNLL = "C_TBNLL",
-    P_TRCHL = "C_TCHLS", P_TCHNT = "C_TCHNT", P_THRCL = "C_THRCL",
-    P_THRMM = "C_THRMM", P_TIARN = "C_TIARN", P_TKPHR = "C_TKPHR",
-    P_TLNMA = "C_TLNMA", P_TLYPM = "C_TLYPM", P_TMNDS = "C_TMNDS",
-    P_TMNTA = "C_TMNTA", P_TNTNN = "C_TNNDM", P_TTNNS = "C_TNTNN",
-    P_TNPSS = "C_TNTNNP", P_TONTN = "C_TONTN", P_TOSAI = "C_TOSAI",
-    P_TPHTR = "C_TPHTR", P_TRCHH = "C_TRCHH", P_TRPHS = "C_TRCHLR",
-    P_TMMNA = "C_TRCHM", P_TRCHS = "C_TRCHSP", P_TRFRN = "C_TRFRN",
-    P_TRLCL = "C_TRLCL", P_TRTXL = "C_TRTXL", P_TRTXS = "C_TRTXS",
-    P_TTRHY = "C_TTRHY", F_TTRMY = "C_TTRMY", P_TXTLR = "C_TXTLR",
-    F_THRST = "C_TYTRM", P_URLPT = "C_ULPTS", P_UNGLT = "C_UNGLT",
-    P_URCNT = "C_URCNT", P_URONM = "C_URONM", P_UROSM = "C_UROSM",
-    P_URTRC = "C_URTRC", P_URSTY = "C_UTYLA", P_UVGRN = "C_UVGRN",
-    P_VLVLN = "C_VALVLN", P_VGNLN = "C_VGNLN", P_VGNLNP = "C_VGNLNP",
-    P_VLNRA = "C_VLVLN", P_VGNCL = "C_VNCLA", P_VRGLN = "C_VRGLN",
-    P_VRGLNP = "C_VRGLNP", P_VRTCL = "C_VRTCL", P_WBBNL = "C_WBBNL",
-    P_WEBBN = "C_WEBBN", P_WSNRL = "C_WSNRL", P_ZTHMN = "C_ZHMNM",
-    B_ZOOGL = "C_ZOOGL", F_DDSCS = "F_DPDSC", F_SCCHR = "F_SMYCS",
-    P_AMTRN = "P_ACNTH", F_AMBDM = "P_AMBDM", F_ARCYR = "P_ARCYR",
-    F_BADHM = "P_BADHM", F_BDHMP = "P_BDHMP", F_BRBYL = "P_BRBYL",
-    F_BRFLD = "P_BRFLD", F_CLMYX = "P_CLMYX", F_CLSTD = "P_CLSTD",
-    F_CMTRC = "P_CMTRC", F_CRBRR = "P_CRBRR", F_CRTMY = "P_CRTMY",
-    F_CRTRM = "P_CRTRM", F_DCTYD = "P_DCTYD", F_DDYMM = "P_DDYMM",
-    F_DIACH = "P_DIACH", F_DIANM = "P_DIANM", F_DIDRM = "P_DIDRM",
-    F_ELMYX = "P_ELMYX", F_ESTLM = "P_ESTLM", F_FULIG = "P_FULIG",
-    F_HMTRC = "P_HMTRC", F_LCRPS = "P_LCRPS", F_LICEA = "P_LICEA",
-    F_LMPRD = "P_LMPRD", F_LPTDR = "P_LPTDR", F_LSTRL = "P_LSTRL",
-    F_LYCGL = "P_LYCGL", F_MCBRD = "P_MCBRD", F_MNKTL = "P_MNKTL",
-    F_MTTRC = "P_MTTRC", F_MUCLG = "P_MUCLG", F_PHYSR = "P_PHYSR",
-    F_PRCHN = "P_PRCHN", F_PRMBD = "P_PRMBD", F_PRTPH = "P_PRTPH",
-    F_PSRNA = "P_PSRNA", F_PYSRM = "P_PYSRM", F_RTCLR = "P_RTCLR",
-    F_STMNT = "P_STMNT", F_SYMPH = "P_SYMPH", F_TRBRK = "P_TRBRK",
-    F_TRICH = "P_TRICH", F_TUBFR = "P_TUBFR",
-    B_GRDNR = "B_GRLLA", B_SGMNS = "B_SNGMNS", B_TCLLS = "B_THBCL",
-    F_CCCCS = "F_CRYPT",
-    # renamings of old genus + species
-    # putting full names here will throw notes with new taxonomic names
-    F_CANDD_GLB = "F_CANDD_GLA", F_CANDD_KRU = "Candida krusei",
-    F_CANDD_GUI = "Candida guilliermondii", F_HNSNL_ANO = "Hansenula anomala",
-    F_CANDD_LUS = "Candida lusitaniae", B_STRPT_TUS = "B_STRPT",
-    B_PRVTL_OLA = "B_PRVTL_OULO", B_FSBCT_RUM = "B_FSBCT",
-    B_CRYNB_EYI = "B_CRYNB_FRE", B_OLGLL_LIS = "B_OLGLL_URE")
-}

README.md

@@ -1,59 +0,0 @@
-% AMR (for R)
-
-# `AMR` (for R)
-<img src="man/figures/logo.png" align="right" height="120px" />
-
-### Not a developer? Then please visit our website [https://msberends.gitlab.io/AMR](https://msberends.gitlab.io/AMR) to read about this package.
-
-**It contains documentation about all of the included functions and also a comprehensive tutorial about how to conduct AMR analysis.**
-
-## Development source
-
-*NOTE: the original source code is on GitLab (https://gitlab.com/msberends/AMR). There is a mirror repository on GitHub (https://github.com/msberends/AMR). As the mirror process is automated by GitLab, both repositories always contain the latest changes.*
-
-This is the **development source** of `AMR`, a free and open-source [R package](https://www.r-project.org) to simplify the analysis and prediction of Antimicrobial Resistance (AMR) and to work with microbial and antimicrobial properties by using evidence-based methods.
-
-## Authors
-Matthijs S. Berends<sup>1,2</sup>,
-Christian F. Luz<sup>1</sup>,
-Alex W. Friedrich1</sup>,
-Bhanu N.M. Sinha<sup>1</sup>,
-Casper J. Albers<sup>3</sup>,
-Corinna Glasner<sup>1</sup>
-  
-<sup>1</sup> Department of Medical Microbiology, University of Groningen, University Medical Center Groningen, Groningen, the Netherlands - [rug.nl](http://www.rug.nl) [umcg.nl](http://www.umcg.nl)<br>
-<sup>2</sup> Certe Medical Diagnostics & Advice, Groningen, the Netherlands - [certe.nl](http://www.certe.nl)<br>
-<sup>3</sup> Heymans Institute for Psychological Research, University of Groningen, Groningen, the Netherlands - [rug.nl](http://www.rug.nl)<br>
-
-<a href="https://www.rug.nl"><img src="man/figures/logo_rug.png" height="60px"></a>
-<a href="https://www.umcg.nl"><img src="man/figures/logo_umcg.png" height="60px"></a>
-<a href="https://www.certe.nl"><img src="man/figures/logo_certe.png" height="60px"></a>
-<a href="http://www.eurhealth-1health.eu"><img src="man/figures/logo_eh1h.png" height="60px"></a>
-<a href="http://www.eurhealth-1health.eu"><img src="man/figures/logo_interreg.png" height="60px"></a>
-
-## How to get this package
-Please see [our website](https://msberends.gitlab.io/AMR/#get-this-package).
-
-## Copyright
-
-This R package is licensed under the [GNU General Public License (GPL) v2.0](https://gitlab.com/msberends/AMR/blob/master/LICENSE). In a nutshell, this means that this package:
-
-- May be used for commercial purposes
-
-- May be used for private purposes
-
-- May **not** be used for patent purposes
-
-- May be modified, although:
-
-  - Modifications **must** be released under the same license when distributing the package
-  - Changes made to the code **must** be documented
-
-- May be distributed, although:
-
-  - Source code **must** be made available when the package is distributed
-  - A copy of the license and copyright notice **must** be included with the package.
-
-- Comes with a LIMITATION of liability
-
-- Comes with NO warranty

_pkgdown.yml

@@ -1,191 +0,0 @@
-# ==================================================================== #
-# TITLE                                                                #
-# Antimicrobial Resistance (AMR) Analysis                              #
-#                                                                      #
-# SOURCE                                                               #
-# https://gitlab.com/msberends/AMR                                     #
-#                                                                      #
-# LICENCE                                                              #
-# (c) 2019 Berends MS (m.s.berends@umcg.nl), Luz CF (c.f.luz@umcg.nl)  #
-#                                                                      #
-# This R package is free software; you can freely use and distribute   #
-# it for both personal and commercial purposes under the terms of the  #
-# GNU General Public License version 2.0 (GNU GPL-2), as published by  #
-# the Free Software Foundation.                                        #
-#                                                                      #
-# This R package was created for academic research and was publicly    #
-# released in the hope that it will be useful, but it comes WITHOUT    #
-# ANY WARRANTY OR LIABILITY.                                           #
-# Visit our website for more info: https://msberends.gitlab.io/AMR.    #
-# ==================================================================== #
-
-title: "AMR (for R)"
-url: "https://msberends.gitlab.io/AMR"
-
-development:
-  mode: "release" # improves indexing by search engines
-  version_tooltip: "Latest development version"
-
-news:
-  one_page: true
-
-navbar:
-  title: "AMR (for R)"
-  left:
-    - text: "Home"
-      icon: "fa-home"
-      href: "index.html"
-    - text: "How to"
-      icon: "fa-question-circle"
-      menu:
-      - text: "Conduct AMR analysis"
-        icon: "fa-directions"
-        href: "articles/AMR.html"
-      - text: "Predict antimicrobial resistance"
-        icon: "fa-dice"
-        href: "articles/resistance_predict.html"
-      - text: "Determine multi-drug resistance (MDR)"
-        icon: "fa-skull-crossbones"
-        href: "articles/MDR.html"
-      - text: "Work with WHONET data"
-        icon: "fa-globe-americas"
-        href: "articles/WHONET.html"
-      - text: "Import data from SPSS/SAS/Stata"
-        icon: "fa-file-upload"
-        href: "articles/SPSS.html"
-      - text: "Apply EUCAST rules"
-        icon: "fa-exchange-alt"
-        href: "articles/EUCAST.html"
-      - text: "Get properties of a microorganism"
-        icon: "fa-bug"
-        href: "reference/mo_property.html" # reference instead of article
-      - text: "Get properties of an antibiotic"
-        icon: "fa-capsules"
-        href: "reference/ab_property.html" # reference instead of article
-      - text: "Other: benchmarks"
-        icon: "fa-shipping-fast"
-        href: "articles/benchmarks.html"
-    - text: "Manual"
-      icon: "fa-book-open"
-      href: "reference/"
-    - text: "Authors"
-      icon: "fa-users"
-      href: "authors.html"
-    - text: "Changelog"
-      icon: "far fa-newspaper"
-      href: "news/"
-  right:
-    - text: "Source Code"
-      icon: "fab fa-gitlab"
-      href: "https://gitlab.com/msberends/AMR"
-    - text: "Licence"
-      icon: "fa-book"
-      href: "LICENSE-text.html"
-
-reference:
-  - title: "Cleaning your data"
-    desc: >
-      Functions for cleaning and optimising your data, to be able to add
-      variables later on (like taxonomic properties) or to fix and extend
-      antibiotic interpretations by applying [EUCAST rules](http://www.eucast.org/expert_rules_and_intrinsic_resistance/).
-    contents:
-    - starts_with("as.")
-    - "`eucast_rules`"
-    - "`guess_ab_col`"
-    - "`mo_source`"
-    - "`read.4D`"
-    - "`rsi_translation`"
-  - title: "Enhancing your data"
-    desc: >
-      Functions to add new data to your existing data, such as the determination
-      of first isolates, multi-drug resistant microorganisms (MDRO), getting
-      properties of microorganisms or antibiotics and determining the age of
-      patients or divide ages into age groups.
-    contents:
-    - "`ab_property`"
-    - "`age_groups`"
-    - "`age`"
-    - "`atc_online_property`"
-    - "`first_isolate`"
-    - "`join`"
-    - "`key_antibiotics`"
-    - "`mdro`"
-    - "`mo_property`"
-    - "`p_symbol`"
-  - title: "Analysing your data"
-    desc: >
-      Functions for conducting AMR analysis, like counting isolates, calculating
-      resistance or susceptibility, or make plots.
-    contents:
-    - "`availability`"
-    - "`bug_drug_combinations`"
-    - "`count`"
-    - "`filter_ab_class`"
-    - "`g.test`"
-    - "`ggplot_rsi`"
-    - "`kurtosis`"
-    - "`portion`"
-    - "`resistance_predict`"
-    - "`skewness`"
-  - title: "Included data sets"
-    desc: >
-      Scientifically reliable references for microorganisms and
-      antibiotics, and example data sets to use for practise.
-    contents:
-    - "`antibiotics`"
-    - "`antivirals`"
-    - "`example_isolates`"
-    - "`microorganisms.codes`"
-    - "`microorganisms.old`"
-    - "`microorganisms`"
-    - "`WHONET`"
-  - title: "Background information"
-    desc: >
-      Some pages about our package and its external sources. Be sure to read our [How To's](./../articles/index.html)
-      for more information about how to work with functions in this package.
-    contents:
-    - "`AMR`"
-    - "`catalogue_of_life`"
-    - "`catalogue_of_life_version`"
-    - "`WHOCC`"
-  - title: Other functions
-    desc: >
-      These functions are mostly for internal use, but some of
-      them may also be suitable for your analysis. Especially the
-      'like' function can be useful: `if (x %like% y) {...}`.
-    contents:
-    - "`get_locale`"
-    - "`extended-functions`"
-    - "`like`"
-    - "`reexports`"
-  - title: Deprecated functions
-    desc: >
-      These functions are deprecated, meaning that they will still
-      work but show a warning with every use and will be removed
-      in a future version.
-    contents:
-    - "`AMR-deprecated`"
-
-authors:
-  Matthijs S. Berends:
-    href: https://www.rug.nl/staff/m.s.berends/
-  Christian F. Luz:
-    href: https://www.rug.nl/staff/c.f.luz/
-  Alex W. Friedrich:
-    href: https://www.rug.nl/staff/a.w.friedrich/
-  Bhanu N. M. Sinha:
-    href: https://www.rug.nl/staff/b.sinha/
-  Casper J. Albers:
-    href: https://www.rug.nl/staff/c.j.albers/
-  Corinna Glasner:
-    href: https://www.rug.nl/staff/c.glasner/
-
-template:
-  assets: "pkgdown/logos" # use logos in this folder
-  params:
-    noindex: false
-    bootswatch: "flatly"
-    docsearch:
-      # using algolia.com
-      api_key: "f737050abfd4d726c63938e18f8c496e"
-      index_name: "amr"

appveyor.yml

@@ -1,80 +0,0 @@
-# ==================================================================== #
-# TITLE                                                                #
-# Antimicrobial Resistance (AMR) Analysis                              #
-#                                                                      #
-# SOURCE                                                               #
-# https://gitlab.com/msberends/AMR                                     #
-#                                                                      #
-# LICENCE                                                              #
-# (c) 2019 Berends MS (m.s.berends@umcg.nl), Luz CF (c.f.luz@umcg.nl)  #
-#                                                                      #
-# This R package is free software; you can freely use and distribute   #
-# it for both personal and commercial purposes under the terms of the  #
-# GNU General Public License version 2.0 (GNU GPL-2), as published by  #
-# the Free Software Foundation.                                        #
-#                                                                      #
-# This R package was created for academic research and was publicly    #
-# released in the hope that it will be useful, but it comes WITHOUT    #
-# ANY WARRANTY OR LIABILITY.                                           #
-# Visit our website for more info: https://msberends.gitlab.io/AMR.    #
-# ==================================================================== #
-
-# Download script file from this GitLab repo
-init:
-  ps: |
-        $ErrorActionPreference = "Stop"
-        Invoke-WebRequest https://gitlab.com/msberends/AMR/raw/master/tests/appveyor/appveyor_tool.ps1 -OutFile "..\appveyor-tool.ps1"
-        Import-Module '..\appveyor-tool.ps1'
-
-install:
-  ps: Bootstrap
-
-cache:
-  - C:\RLibrary
-
-# Adapt as necessary starting from here
-
-environment:
-  R_ARCH: x64
-  GCC_PATH: mingw_64
-  WARNINGS_ARE_ERRORS: 1
-  PKGTYPE: both
-  USE_RTOOLS: true
-
-  matrix:
-  - R_VERSION: oldrel
-  - R_VERSION: release
-  - R_VERSION: devel
-
-matrix:
-  allow_failures:
-  - R_VERSION: "devel" # 9 nov 19: searches for R 4.0 and now fails...
-
-build_script:
-  - travis_tool.sh install_deps
-
-test_script:
-  - travis_tool.sh run_tests
-
-on_failure:
-  - 7z a failure.zip *.Rcheck\*
-  - appveyor PushArtifact failure.zip
-
-artifacts:
-  - path: '*.Rcheck\**\*.log'
-    name: Logs
-
-  - path: '*.Rcheck\**\*.out'
-    name: Logs
-
-  - path: '*.Rcheck\**\*.fail'
-    name: Logs
-
-  - path: '*.Rcheck\**\*.Rout'
-    name: Logs
-
-  - path: '\*_*.tar.gz'
-    name: Bits
-
-  - path: '\*_*.zip'
-    name: Bits

articles/AMR_for_Python.html

@@ -0,0 +1,289 @@
+<!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>AMR for Python • 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.4.2/css/all.min.css" rel="stylesheet">
+<link href="../deps/font-awesome-6.4.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="AMR for Python">
+</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.9084</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="../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="active 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="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-article">
+
+
+
+
+<div class="row">
+  <main id="main" class="col-md-9"><div class="page-header">
+      <img src="../logo.svg" class="logo" alt=""><h1>AMR for Python</h1>
+            
+      
+      <small class="dont-index">Source: <a href="https://github.com/msberends/AMR/blob/main/vignettes/AMR_for_Python.Rmd" class="external-link"><code>vignettes/AMR_for_Python.Rmd</code></a></small>
+      <div class="d-none name"><code>AMR_for_Python.Rmd</code></div>
+    </div>
+
+    
+    
+<div class="section level2">
+<h2 id="introduction">Introduction<a class="anchor" aria-label="anchor" href="#introduction"></a>
+</h2>
+<p>The <code>AMR</code> package for R is an incredible tool for
+antimicrobial resistance (AMR) data analysis, providing extensive
+functionality for working with microbial and antimicrobial properties.
+But what if you’re working in Python and still want to benefit from the
+robust features of <code>AMR</code>?</p>
+<p>Luckily, there is no need to port the package to Python! With the
+help of <code>rpy2</code>, a powerful Python package, you can easily
+access R from Python and call functions from the <code>AMR</code>
+package to process your own data. This post will guide you through
+setting up <code>rpy2</code> and show you how to use R functions from
+<code>AMR</code> in Python to supercharge your antimicrobial resistance
+analysis.</p>
+</div>
+<div class="section level2">
+<h2 id="what-is-rpy2">What is <code>rpy2</code>?<a class="anchor" aria-label="anchor" href="#what-is-rpy2"></a>
+</h2>
+<p><code>rpy2</code> is a Python library that allows Python users to run
+R code within their Python scripts. Essentially, it acts as a bridge
+between the two languages, allowing you to tap into the rich ecosystem
+of R libraries (like <code>AMR</code>) while maintaining the flexibility
+of Python.</p>
+<div class="section level3">
+<h3 id="key-features-of-rpy2">Key Features of <code>rpy2</code>:<a class="anchor" aria-label="anchor" href="#key-features-of-rpy2"></a>
+</h3>
+<ul>
+<li>Seamlessly call R functions from Python.</li>
+<li>Convert R data structures into Python data structures like pandas
+DataFrames.</li>
+<li>Leverage the full power of R libraries without leaving your Python
+environment.</li>
+</ul>
+</div>
+</div>
+<div class="section level2">
+<h2 id="setting-up-rpy2">Setting Up <code>rpy2</code><a class="anchor" aria-label="anchor" href="#setting-up-rpy2"></a>
+</h2>
+<p>Before diving into the examples, you’ll need to install both R and
+<code>rpy2</code>. Here’s a step-by-step guide on setting things up.</p>
+<div class="section level3">
+<h3 id="step-1-install-r">Step 1: Install R<a class="anchor" aria-label="anchor" href="#step-1-install-r"></a>
+</h3>
+<p>Ensure that you have R installed on your system. You can download R
+from <a href="https://cran.r-project.org/" class="external-link">CRAN</a>.</p>
+</div>
+<div class="section level3">
+<h3 id="step-2-install-the-amr-package-in-r">Step 2: Install the <code>AMR</code> package in R<a class="anchor" aria-label="anchor" href="#step-2-install-the-amr-package-in-r"></a>
+</h3>
+<p>Once you have R installed, open your R console and install the
+<code>AMR</code> package:</p>
+<div class="sourceCode" id="cb1"><pre class="downlit sourceCode r">
+<code class="sourceCode R"><span><span class="fu"><a href="https://rdrr.io/r/utils/install.packages.html" class="external-link">install.packages</a></span><span class="op">(</span><span class="st">"AMR"</span><span class="op">)</span></span></code></pre></div>
+<p>You can also install the latest development version of the
+<code>AMR</code> package if needed:</p>
+<div class="sourceCode" id="cb2"><pre class="downlit sourceCode r">
+<code class="sourceCode R"><span><span class="fu"><a href="https://rdrr.io/r/utils/install.packages.html" class="external-link">install.packages</a></span><span class="op">(</span><span class="st">"AMR"</span>, repos <span class="op">=</span> <span class="st">"https://msberends.r-universe.dev"</span><span class="op">)</span></span></code></pre></div>
+</div>
+<div class="section level3">
+<h3 id="step-3-install-rpy2-in-python">Step 3: Install <code>rpy2</code> in Python<a class="anchor" aria-label="anchor" href="#step-3-install-rpy2-in-python"></a>
+</h3>
+<p>To install <code>rpy2</code>, simply run the following command in
+your terminal:</p>
+<div class="sourceCode" id="cb3"><pre class="sourceCode bash"><code class="sourceCode bash"><span id="cb3-1"><a href="#cb3-1" tabindex="-1"></a><span class="ex">pip</span> install rpy2</span></code></pre></div>
+</div>
+<div class="section level3">
+<h3 id="step-4-test-rpy2-installation">Step 4: Test <code>rpy2</code> Installation<a class="anchor" aria-label="anchor" href="#step-4-test-rpy2-installation"></a>
+</h3>
+<p>To ensure everything is set up correctly, you can test your
+installation by running the following Python script:</p>
+<div class="sourceCode" id="cb4"><pre class="sourceCode python"><code class="sourceCode python"><span id="cb4-1"><a href="#cb4-1" tabindex="-1"></a><span class="im">import</span> rpy2.robjects <span class="im">as</span> ro</span>
+<span id="cb4-2"><a href="#cb4-2" tabindex="-1"></a></span>
+<span id="cb4-3"><a href="#cb4-3" tabindex="-1"></a><span class="co"># Test a simple R function from Python</span></span>
+<span id="cb4-4"><a href="#cb4-4" tabindex="-1"></a>ro.r(<span class="st">'1 + 1'</span>)</span></code></pre></div>
+<p>If this returns <code>2</code>, you’re good to go!</p>
+</div>
+</div>
+<div class="section level2">
+<h2 id="working-with-amr-in-python-using-rpy2">Working with AMR in Python using <code>rpy2</code><a class="anchor" aria-label="anchor" href="#working-with-amr-in-python-using-rpy2"></a>
+</h2>
+<p>Now that we have <code>rpy2</code> set up, let’s walk through some
+practical examples of using the <code>AMR</code> package within
+Python.</p>
+<div class="section level3">
+<h3 id="example-1-loading-amr-and-example-data">Example 1: Loading <code>AMR</code> and Example Data<a class="anchor" aria-label="anchor" href="#example-1-loading-amr-and-example-data"></a>
+</h3>
+<p>Let’s start by converting taxonomic user input to valid taxonomy
+using the <code>AMR</code> package, from within Python:</p>
+<div class="sourceCode" id="cb5"><pre class="sourceCode python"><code class="sourceCode python"><span id="cb5-1"><a href="#cb5-1" tabindex="-1"></a><span class="im">import</span> pandas <span class="im">as</span> pd</span>
+<span id="cb5-2"><a href="#cb5-2" tabindex="-1"></a><span class="im">import</span> rpy2.robjects <span class="im">as</span> ro</span>
+<span id="cb5-3"><a href="#cb5-3" tabindex="-1"></a><span class="im">from</span> rpy2.robjects.packages <span class="im">import</span> importr</span>
+<span id="cb5-4"><a href="#cb5-4" tabindex="-1"></a><span class="im">from</span> rpy2.robjects <span class="im">import</span> pandas2ri</span>
+<span id="cb5-5"><a href="#cb5-5" tabindex="-1"></a></span>
+<span id="cb5-6"><a href="#cb5-6" tabindex="-1"></a><span class="co"># Enable conversion between pandas and R data frames</span></span>
+<span id="cb5-7"><a href="#cb5-7" tabindex="-1"></a>pandas2ri.activate()</span>
+<span id="cb5-8"><a href="#cb5-8" tabindex="-1"></a></span>
+<span id="cb5-9"><a href="#cb5-9" tabindex="-1"></a><span class="co"># Load the AMR package from R</span></span>
+<span id="cb5-10"><a href="#cb5-10" tabindex="-1"></a>amr <span class="op">=</span> importr(<span class="st">'AMR'</span>)</span>
+<span id="cb5-11"><a href="#cb5-11" tabindex="-1"></a></span>
+<span id="cb5-12"><a href="#cb5-12" tabindex="-1"></a><span class="co"># Example user dataset in Python</span></span>
+<span id="cb5-13"><a href="#cb5-13" tabindex="-1"></a>data <span class="op">=</span> pd.DataFrame({</span>
+<span id="cb5-14"><a href="#cb5-14" tabindex="-1"></a>    <span class="st">'microorganism'</span>: [<span class="st">'E. coli'</span>, <span class="st">'S. aureus'</span>, <span class="st">'P. aeruginosa'</span>, <span class="st">'K. pneumoniae'</span>]</span>
+<span id="cb5-15"><a href="#cb5-15" tabindex="-1"></a>})</span>
+<span id="cb5-16"><a href="#cb5-16" tabindex="-1"></a></span>
+<span id="cb5-17"><a href="#cb5-17" tabindex="-1"></a><span class="co"># Convert the Python DataFrame to an R DataFrame</span></span>
+<span id="cb5-18"><a href="#cb5-18" tabindex="-1"></a>r_data <span class="op">=</span> pandas2ri.py2rpy(data)</span>
+<span id="cb5-19"><a href="#cb5-19" tabindex="-1"></a></span>
+<span id="cb5-20"><a href="#cb5-20" tabindex="-1"></a><span class="co"># Apply mo_name() from the AMR package to the 'microorganism' column</span></span>
+<span id="cb5-21"><a href="#cb5-21" tabindex="-1"></a>ro.globalenv[<span class="st">'r_data'</span>] <span class="op">=</span> r_data</span>
+<span id="cb5-22"><a href="#cb5-22" tabindex="-1"></a>ro.r(<span class="st">'r_data$mo_name &lt;- mo_name(r_data$microorganism)'</span>)</span>
+<span id="cb5-23"><a href="#cb5-23" tabindex="-1"></a></span>
+<span id="cb5-24"><a href="#cb5-24" tabindex="-1"></a><span class="co"># Retrieve and print the modified R DataFrame in Python</span></span>
+<span id="cb5-25"><a href="#cb5-25" tabindex="-1"></a>result <span class="op">=</span> ro.r(<span class="st">'as.data.frame(r_data)'</span>)</span>
+<span id="cb5-26"><a href="#cb5-26" tabindex="-1"></a>result <span class="op">=</span> pandas2ri.rpy2py(result)</span>
+<span id="cb5-27"><a href="#cb5-27" tabindex="-1"></a><span class="bu">print</span>(result)</span></code></pre></div>
+<p>In this example, a Python dataset with microorganism names like
+<em>E. coli</em> and <em>S. aureus</em> is passed to the R function
+<code><a href="../reference/mo_property.html">mo_name()</a></code>. The result is an updated <code>DataFrame</code>
+that includes the standardised microorganism names based on the
+<code><a href="../reference/mo_property.html">mo_name()</a></code> function from the <code>AMR</code> package.</p>
+</div>
+<div class="section level3">
+<h3 id="example-2-generating-an-antibiogram">Example 2: Generating an Antibiogram<a class="anchor" aria-label="anchor" href="#example-2-generating-an-antibiogram"></a>
+</h3>
+<p>One of the core functions of the <code>AMR</code> package is
+generating an antibiogram, a table that summarises the antimicrobial
+susceptibility of bacterial isolates. Here’s how you can generate an
+antibiogram from Python:</p>
+<div class="sourceCode" id="cb6"><pre class="sourceCode python"><code class="sourceCode python"><span id="cb6-1"><a href="#cb6-1" tabindex="-1"></a><span class="co"># Run an antibiogram in R from Python</span></span>
+<span id="cb6-2"><a href="#cb6-2" tabindex="-1"></a>ro.r(<span class="st">'result &lt;- antibiogram(example_isolates, antibiotics = c(aminoglycosides(), carbapenems()))'</span>)</span>
+<span id="cb6-3"><a href="#cb6-3" tabindex="-1"></a></span>
+<span id="cb6-4"><a href="#cb6-4" tabindex="-1"></a><span class="co"># Retrieve the result in Python</span></span>
+<span id="cb6-5"><a href="#cb6-5" tabindex="-1"></a>result <span class="op">=</span> ro.r(<span class="st">'as.data.frame(result)'</span>)</span>
+<span id="cb6-6"><a href="#cb6-6" tabindex="-1"></a><span class="bu">print</span>(result)</span></code></pre></div>
+<p>In this example, we generate an antibiogram by selecting
+aminoglycosides and carbapenems, two classes of antibiotics, and then
+convert the resulting R data frame into a Python-readable format.</p>
+</div>
+<div class="section level3">
+<h3 id="example-3-filtering-data-based-on-gram-negative-bacteria">Example 3: Filtering Data Based on Gram-Negative Bacteria<a class="anchor" aria-label="anchor" href="#example-3-filtering-data-based-on-gram-negative-bacteria"></a>
+</h3>
+<p>Let’s say you want to filter the dataset for Gram-negative bacteria
+and display their resistance to certain antibiotics:</p>
+<div class="sourceCode" id="cb7"><pre class="sourceCode python"><code class="sourceCode python"><span id="cb7-1"><a href="#cb7-1" tabindex="-1"></a><span class="co"># Filter for Gram-negative bacteria with intrinsic resistance to cefotaxime</span></span>
+<span id="cb7-2"><a href="#cb7-2" tabindex="-1"></a>ro.r(<span class="st">'result &lt;- example_isolates[which(mo_is_gram_negative() &amp; mo_is_intrinsic_resistant(ab = "cefotax")), c("bacteria", aminoglycosides(), carbapenems())]'</span>)</span>
+<span id="cb7-3"><a href="#cb7-3" tabindex="-1"></a></span>
+<span id="cb7-4"><a href="#cb7-4" tabindex="-1"></a><span class="co"># Retrieve the filtered result in Python</span></span>
+<span id="cb7-5"><a href="#cb7-5" tabindex="-1"></a>result <span class="op">=</span> ro.r(<span class="st">'as.data.frame(result)'</span>)</span>
+<span id="cb7-6"><a href="#cb7-6" tabindex="-1"></a><span class="bu">print</span>(result)</span></code></pre></div>
+<p>This example uses the AMR functions
+<code><a href="../reference/mo_property.html">mo_is_gram_negative()</a></code> and
+<code><a href="../reference/mo_property.html">mo_is_intrinsic_resistant()</a></code> to filter the dataset and
+returns a subset of bacteria with resistance data.</p>
+</div>
+<div class="section level3">
+<h3 id="example-4-customising-the-antibiogram">Example 4: Customising the Antibiogram<a class="anchor" aria-label="anchor" href="#example-4-customising-the-antibiogram"></a>
+</h3>
+<p>You can easily customise the antibiogram by passing different
+antibiotics or microorganism transformations, as shown below:</p>
+<div class="sourceCode" id="cb8"><pre class="sourceCode python"><code class="sourceCode python"><span id="cb8-1"><a href="#cb8-1" tabindex="-1"></a><span class="co"># Customise the antibiogram with different settings</span></span>
+<span id="cb8-2"><a href="#cb8-2" tabindex="-1"></a>ro.r(<span class="st">'result &lt;- antibiogram(example_isolates, antibiotics = c("TZP", "TZP+TOB", "TZP+GEN"), mo_transform = "gramstain")'</span>)</span>
+<span id="cb8-3"><a href="#cb8-3" tabindex="-1"></a></span>
+<span id="cb8-4"><a href="#cb8-4" tabindex="-1"></a><span class="co"># Retrieve and print the result</span></span>
+<span id="cb8-5"><a href="#cb8-5" tabindex="-1"></a>result <span class="op">=</span> ro.r(<span class="st">'as.data.frame(result)'</span>)</span>
+<span id="cb8-6"><a href="#cb8-6" tabindex="-1"></a><span class="bu">print</span>(result)</span></code></pre></div>
+<p>Here, we use piperacillin/tazobactam (TZP) in combination with
+tobramycin (TOB) and gentamicin (GEN) to see how they perform against
+various Gram-negative bacteria.</p>
+</div>
+</div>
+<div class="section level2">
+<h2 id="conclusion">Conclusion<a class="anchor" aria-label="anchor" href="#conclusion"></a>
+</h2>
+<p>Using <code>rpy2</code>, you can easily integrate the power of R’s
+<code>AMR</code> package into your Python workflows. Whether you are
+generating antibiograms, analyzing resistance data, or performing
+complex filtering, <code>rpy2</code> gives you the flexibility to run R
+code without leaving the Python environment. This makes it a perfect
+solution for teams working across both R and Python.</p>
+</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>

articles/EUCAST.html

@@ -0,0 +1,333 @@
+<!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>How to apply EUCAST rules • 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.4.2/css/all.min.css" rel="stylesheet">
+<link href="../deps/font-awesome-6.4.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="How to apply EUCAST rules">
+</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.9084</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="active 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="../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="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-article">
+
+
+
+
+<div class="row">
+  <main id="main" class="col-md-9"><div class="page-header">
+      <img src="../logo.svg" class="logo" alt=""><h1>How to apply EUCAST rules</h1>
+            
+      
+      <small class="dont-index">Source: <a href="https://github.com/msberends/AMR/blob/main/vignettes/EUCAST.Rmd" class="external-link"><code>vignettes/EUCAST.Rmd</code></a></small>
+      <div class="d-none name"><code>EUCAST.Rmd</code></div>
+    </div>
+
+    
+    
+<div class="section level2">
+<h2 id="introduction">Introduction<a class="anchor" aria-label="anchor" href="#introduction"></a>
+</h2>
+<p>What are EUCAST rules? The European Committee on Antimicrobial
+Susceptibility Testing (EUCAST) states <a href="https://www.eucast.org/expert_rules_and_intrinsic_resistance/" class="external-link">on
+their website</a>:</p>
+<blockquote>
+<p><em>EUCAST expert rules are a tabulated collection of expert
+knowledge on intrinsic resistances, exceptional resistance phenotypes
+and interpretive rules that may be applied to antimicrobial
+susceptibility testing in order to reduce errors and make appropriate
+recommendations for reporting particular resistances.</em></p>
+</blockquote>
+<p>In Europe, a lot of medical microbiological laboratories already
+apply these rules (<a href="https://www.eurosurveillance.org/content/10.2807/1560-7917.ES2015.20.2.21008" class="external-link">Brown
+<em>et al.</em>, 2015</a>). Our package features their latest insights
+on intrinsic resistance and unusual phenotypes (v3.1, 2016).</p>
+<p>Moreover, the <code><a href="../reference/eucast_rules.html">eucast_rules()</a></code> function we use for this
+purpose can also apply additional rules, like forcing
+<help title="ATC: J01CA01">ampicillin</help> = R in isolates when
+<help title="ATC: J01CR02">amoxicillin/clavulanic acid</help> = R.</p>
+</div>
+<div class="section level2">
+<h2 id="examples">Examples<a class="anchor" aria-label="anchor" href="#examples"></a>
+</h2>
+<p>These rules can be used to discard impossible bug-drug combinations
+in your data. For example, <em>Klebsiella</em> produces beta-lactamase
+that prevents ampicillin (or amoxicillin) from working against it. In
+other words, practically every strain of <em>Klebsiella</em> is
+resistant to ampicillin.</p>
+<p>Sometimes, laboratory data can still contain such strains with
+ampicillin being susceptible to ampicillin. This could be because an
+antibiogram is available before an identification is available, and the
+antibiogram is then not re-interpreted based on the identification
+(namely, <em>Klebsiella</em>). EUCAST expert rules solve this, that can
+be applied using <code><a href="../reference/eucast_rules.html">eucast_rules()</a></code>:</p>
+<div class="sourceCode" id="cb1"><pre class="downlit sourceCode r">
+<code class="sourceCode R"><span><span class="va">oops</span> <span class="op">&lt;-</span> <span class="fu"><a href="https://rdrr.io/r/base/data.frame.html" class="external-link">data.frame</a></span><span class="op">(</span></span>
+<span>  mo <span class="op">=</span> <span class="fu"><a href="https://rdrr.io/r/base/c.html" class="external-link">c</a></span><span class="op">(</span></span>
+<span>    <span class="st">"Klebsiella"</span>,</span>
+<span>    <span class="st">"Escherichia"</span></span>
+<span>  <span class="op">)</span>,</span>
+<span>  ampicillin <span class="op">=</span> <span class="st">"S"</span></span>
+<span><span class="op">)</span></span>
+<span><span class="va">oops</span></span>
+<span><span class="co">#&gt;            mo ampicillin</span></span>
+<span><span class="co">#&gt; 1  Klebsiella          S</span></span>
+<span><span class="co">#&gt; 2 Escherichia          S</span></span>
+<span></span>
+<span><span class="fu"><a href="../reference/eucast_rules.html">eucast_rules</a></span><span class="op">(</span><span class="va">oops</span>, info <span class="op">=</span> <span class="cn">FALSE</span><span class="op">)</span></span>
+<span><span class="co">#&gt;            mo ampicillin</span></span>
+<span><span class="co">#&gt; 1  Klebsiella          R</span></span>
+<span><span class="co">#&gt; 2 Escherichia          S</span></span></code></pre></div>
+<p>A more convenient function is
+<code><a href="../reference/mo_property.html">mo_is_intrinsic_resistant()</a></code> that uses the same guideline,
+but allows to check for one or more specific microorganisms or
+antibiotics:</p>
+<div class="sourceCode" id="cb2"><pre class="downlit sourceCode r">
+<code class="sourceCode R"><span><span class="fu"><a href="../reference/mo_property.html">mo_is_intrinsic_resistant</a></span><span class="op">(</span></span>
+<span>  <span class="fu"><a href="https://rdrr.io/r/base/c.html" class="external-link">c</a></span><span class="op">(</span><span class="st">"Klebsiella"</span>, <span class="st">"Escherichia"</span><span class="op">)</span>,</span>
+<span>  <span class="st">"ampicillin"</span></span>
+<span><span class="op">)</span></span>
+<span><span class="co">#&gt; [1]  TRUE FALSE</span></span>
+<span></span>
+<span><span class="fu"><a href="../reference/mo_property.html">mo_is_intrinsic_resistant</a></span><span class="op">(</span></span>
+<span>  <span class="st">"Klebsiella"</span>,</span>
+<span>  <span class="fu"><a href="https://rdrr.io/r/base/c.html" class="external-link">c</a></span><span class="op">(</span><span class="st">"ampicillin"</span>, <span class="st">"kanamycin"</span><span class="op">)</span></span>
+<span><span class="op">)</span></span>
+<span><span class="co">#&gt; [1]  TRUE FALSE</span></span></code></pre></div>
+<p>EUCAST rules can not only be used for correction, they can also be
+used for filling in known resistance and susceptibility based on results
+of other antimicrobials drugs. This process is called <em>interpretive
+reading</em>, is basically a form of imputation, and is part of the
+<code><a href="../reference/eucast_rules.html">eucast_rules()</a></code> function as well:</p>
+<div class="sourceCode" id="cb3"><pre class="downlit sourceCode r">
+<code class="sourceCode R"><span><span class="va">data</span> <span class="op">&lt;-</span> <span class="fu"><a href="https://rdrr.io/r/base/data.frame.html" class="external-link">data.frame</a></span><span class="op">(</span></span>
+<span>  mo <span class="op">=</span> <span class="fu"><a href="https://rdrr.io/r/base/c.html" class="external-link">c</a></span><span class="op">(</span></span>
+<span>    <span class="st">"Staphylococcus aureus"</span>,</span>
+<span>    <span class="st">"Enterococcus faecalis"</span>,</span>
+<span>    <span class="st">"Escherichia coli"</span>,</span>
+<span>    <span class="st">"Klebsiella pneumoniae"</span>,</span>
+<span>    <span class="st">"Pseudomonas aeruginosa"</span></span>
+<span>  <span class="op">)</span>,</span>
+<span>  VAN <span class="op">=</span> <span class="st">"-"</span>, <span class="co"># Vancomycin</span></span>
+<span>  AMX <span class="op">=</span> <span class="st">"-"</span>, <span class="co"># Amoxicillin</span></span>
+<span>  COL <span class="op">=</span> <span class="st">"-"</span>, <span class="co"># Colistin</span></span>
+<span>  CAZ <span class="op">=</span> <span class="st">"-"</span>, <span class="co"># Ceftazidime</span></span>
+<span>  CXM <span class="op">=</span> <span class="st">"-"</span>, <span class="co"># Cefuroxime</span></span>
+<span>  PEN <span class="op">=</span> <span class="st">"S"</span>, <span class="co"># Benzylenicillin</span></span>
+<span>  FOX <span class="op">=</span> <span class="st">"S"</span>, <span class="co"># Cefoxitin</span></span>
+<span>  stringsAsFactors <span class="op">=</span> <span class="cn">FALSE</span></span>
+<span><span class="op">)</span></span></code></pre></div>
+<div class="sourceCode" id="cb4"><pre class="downlit sourceCode r">
+<code class="sourceCode R"><span><span class="va">data</span></span></code></pre></div>
+<table class="table">
+<thead><tr class="header">
+<th align="left">mo</th>
+<th align="center">VAN</th>
+<th align="center">AMX</th>
+<th align="center">COL</th>
+<th align="center">CAZ</th>
+<th align="center">CXM</th>
+<th align="center">PEN</th>
+<th align="center">FOX</th>
+</tr></thead>
+<tbody>
+<tr class="odd">
+<td align="left">Staphylococcus aureus</td>
+<td align="center">-</td>
+<td align="center">-</td>
+<td align="center">-</td>
+<td align="center">-</td>
+<td align="center">-</td>
+<td align="center">S</td>
+<td align="center">S</td>
+</tr>
+<tr class="even">
+<td align="left">Enterococcus faecalis</td>
+<td align="center">-</td>
+<td align="center">-</td>
+<td align="center">-</td>
+<td align="center">-</td>
+<td align="center">-</td>
+<td align="center">S</td>
+<td align="center">S</td>
+</tr>
+<tr class="odd">
+<td align="left">Escherichia coli</td>
+<td align="center">-</td>
+<td align="center">-</td>
+<td align="center">-</td>
+<td align="center">-</td>
+<td align="center">-</td>
+<td align="center">S</td>
+<td align="center">S</td>
+</tr>
+<tr class="even">
+<td align="left">Klebsiella pneumoniae</td>
+<td align="center">-</td>
+<td align="center">-</td>
+<td align="center">-</td>
+<td align="center">-</td>
+<td align="center">-</td>
+<td align="center">S</td>
+<td align="center">S</td>
+</tr>
+<tr class="odd">
+<td align="left">Pseudomonas aeruginosa</td>
+<td align="center">-</td>
+<td align="center">-</td>
+<td align="center">-</td>
+<td align="center">-</td>
+<td align="center">-</td>
+<td align="center">S</td>
+<td align="center">S</td>
+</tr>
+</tbody>
+</table>
+<div class="sourceCode" id="cb5"><pre class="downlit sourceCode r">
+<code class="sourceCode R"><span><span class="fu"><a href="../reference/eucast_rules.html">eucast_rules</a></span><span class="op">(</span><span class="va">data</span><span class="op">)</span></span></code></pre></div>
+<table class="table">
+<thead><tr class="header">
+<th align="left">mo</th>
+<th align="center">VAN</th>
+<th align="center">AMX</th>
+<th align="center">COL</th>
+<th align="center">CAZ</th>
+<th align="center">CXM</th>
+<th align="center">PEN</th>
+<th align="center">FOX</th>
+</tr></thead>
+<tbody>
+<tr class="odd">
+<td align="left">Staphylococcus aureus</td>
+<td align="center">-</td>
+<td align="center">S</td>
+<td align="center">R</td>
+<td align="center">S</td>
+<td align="center">S</td>
+<td align="center">S</td>
+<td align="center">S</td>
+</tr>
+<tr class="even">
+<td align="left">Enterococcus faecalis</td>
+<td align="center">-</td>
+<td align="center">-</td>
+<td align="center">R</td>
+<td align="center">R</td>
+<td align="center">R</td>
+<td align="center">S</td>
+<td align="center">R</td>
+</tr>
+<tr class="odd">
+<td align="left">Escherichia coli</td>
+<td align="center">R</td>
+<td align="center">-</td>
+<td align="center">-</td>
+<td align="center">-</td>
+<td align="center">-</td>
+<td align="center">R</td>
+<td align="center">S</td>
+</tr>
+<tr class="even">
+<td align="left">Klebsiella pneumoniae</td>
+<td align="center">R</td>
+<td align="center">R</td>
+<td align="center">-</td>
+<td align="center">-</td>
+<td align="center">-</td>
+<td align="center">R</td>
+<td align="center">S</td>
+</tr>
+<tr class="odd">
+<td align="left">Pseudomonas aeruginosa</td>
+<td align="center">R</td>
+<td align="center">R</td>
+<td align="center">-</td>
+<td align="center">-</td>
+<td align="center">R</td>
+<td align="center">R</td>
+<td align="center">R</td>
+</tr>
+</tbody>
+</table>
+</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>

articles/MDR.html

@@ -0,0 +1,402 @@
+<!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>How to determine multi-drug resistance (MDR) • 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.4.2/css/all.min.css" rel="stylesheet">
+<link href="../deps/font-awesome-6.4.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="How to determine multi-drug resistance (MDR)">
+</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.9084</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="active 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="../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="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-article">
+
+
+
+
+<div class="row">
+  <main id="main" class="col-md-9"><div class="page-header">
+      <img src="../logo.svg" class="logo" alt=""><h1>How to determine multi-drug resistance (MDR)</h1>
+            
+      
+      <small class="dont-index">Source: <a href="https://github.com/msberends/AMR/blob/main/vignettes/MDR.Rmd" class="external-link"><code>vignettes/MDR.Rmd</code></a></small>
+      <div class="d-none name"><code>MDR.Rmd</code></div>
+    </div>
+
+    
+    
+<p>With the function <code><a href="../reference/mdro.html">mdro()</a></code>, you can determine which
+micro-organisms are multi-drug resistant organisms (MDRO).</p>
+<div class="section level3">
+<h3 id="type-of-input">Type of input<a class="anchor" aria-label="anchor" href="#type-of-input"></a>
+</h3>
+<p>The <code><a href="../reference/mdro.html">mdro()</a></code> function takes a data set as input, such as a
+regular <code>data.frame</code>. It tries to automatically determine the
+right columns for info about your isolates, such as the name of the
+species and all columns with results of antimicrobial agents. See the
+help page for more info about how to set the right settings for your
+data with the command <code><a href="../reference/mdro.html">?mdro</a></code>.</p>
+<p>For WHONET data (and most other data), all settings are automatically
+set correctly.</p>
+</div>
+<div class="section level3">
+<h3 id="guidelines">Guidelines<a class="anchor" aria-label="anchor" href="#guidelines"></a>
+</h3>
+<p>The <code><a href="../reference/mdro.html">mdro()</a></code> function support multiple guidelines. You can
+select a guideline with the <code>guideline</code> parameter. Currently
+supported guidelines are (case-insensitive):</p>
+<ul>
+<li>
+<p><code>guideline = "CMI2012"</code> (default)</p>
+<p>Magiorakos AP, Srinivasan A <em>et al.</em> “Multidrug-resistant,
+extensively drug-resistant and pandrug-resistant bacteria: an
+international expert proposal for interim standard definitions for
+acquired resistance.” Clinical Microbiology and Infection (2012) (<a href="https://www.clinicalmicrobiologyandinfection.com/article/S1198-743X(14)61632-3/fulltext" class="external-link">link</a>)</p>
+</li>
+<li>
+<p><code>guideline = "EUCAST3.2"</code> (or simply
+<code>guideline = "EUCAST"</code>)</p>
+<p>The European international guideline - EUCAST Expert Rules Version
+3.2 “Intrinsic Resistance and Unusual Phenotypes” (<a href="https://www.eucast.org/fileadmin/src/media/PDFs/EUCAST_files/Expert_Rules/2020/Intrinsic_Resistance_and_Unusual_Phenotypes_Tables_v3.2_20200225.pdf" class="external-link">link</a>)</p>
+</li>
+<li>
+<p><code>guideline = "EUCAST3.1"</code></p>
+<p>The European international guideline - EUCAST Expert Rules Version
+3.1 “Intrinsic Resistance and Exceptional Phenotypes Tables” (<a href="https://www.eucast.org/fileadmin/src/media/PDFs/EUCAST_files/Expert_Rules/Expert_rules_intrinsic_exceptional_V3.1.pdf" class="external-link">link</a>)</p>
+</li>
+<li>
+<p><code>guideline = "TB"</code></p>
+<p>The international guideline for multi-drug resistant tuberculosis -
+World Health Organization “Companion handbook to the WHO guidelines for
+the programmatic management of drug-resistant tuberculosis” (<a href="https://www.who.int/tb/publications/pmdt_companionhandbook/en/" class="external-link">link</a>)</p>
+</li>
+<li>
+<p><code>guideline = "MRGN"</code></p>
+<p>The German national guideline - Mueller <em>et al.</em> (2015)
+Antimicrobial Resistance and Infection Control 4:7. DOI:
+10.1186/s13756-015-0047-6</p>
+</li>
+<li>
+<p><code>guideline = "BRMO"</code></p>
+<p>The Dutch national guideline - Rijksinstituut voor Volksgezondheid en
+Milieu “WIP-richtlijn BRMO (Bijzonder Resistente Micro-Organismen)
+(ZKH)” (<a href="https://www.rivm.nl/wip-richtlijn-brmo-bijzonder-resistente-micro-organismen-zkh" class="external-link">link</a>)</p>
+</li>
+</ul>
+<p>Please suggest your own (country-specific) guidelines by letting us
+know: <a href="https://github.com/msberends/AMR/issues/new" class="external-link uri">https://github.com/msberends/AMR/issues/new</a>.</p>
+<div class="section level4">
+<h4 id="custom-guidelines">Custom Guidelines<a class="anchor" aria-label="anchor" href="#custom-guidelines"></a>
+</h4>
+<p>You can also use your own custom guideline. Custom guidelines can be
+set with the <code><a href="../reference/mdro.html">custom_mdro_guideline()</a></code> function. This is of
+great importance if you have custom rules to determine MDROs in your
+hospital, e.g., rules that are dependent on ward, state of contact
+isolation or other variables in your data.</p>
+<p>If you are familiar with <code><a href="https://dplyr.tidyverse.org/reference/case_when.html" class="external-link">case_when()</a></code> of the
+<code>dplyr</code> package, you will recognise the input method to set
+your own rules. Rules must be set using what R considers to be the
+‘formula notation’:</p>
+<div class="sourceCode" id="cb1"><pre class="downlit sourceCode r">
+<code class="sourceCode R"><span><span class="va">custom</span> <span class="op">&lt;-</span> <span class="fu"><a href="../reference/mdro.html">custom_mdro_guideline</a></span><span class="op">(</span></span>
+<span>  <span class="va">CIP</span> <span class="op">==</span> <span class="st">"R"</span> <span class="op">&amp;</span> <span class="va">age</span> <span class="op">&gt;</span> <span class="fl">60</span> <span class="op">~</span> <span class="st">"Elderly Type A"</span>,</span>
+<span>  <span class="va">ERY</span> <span class="op">==</span> <span class="st">"R"</span> <span class="op">&amp;</span> <span class="va">age</span> <span class="op">&gt;</span> <span class="fl">60</span> <span class="op">~</span> <span class="st">"Elderly Type B"</span></span>
+<span><span class="op">)</span></span></code></pre></div>
+<p>If a row/an isolate matches the first rule, the value after the first
+<code>~</code> (in this case <em>‘Elderly Type A’</em>) will be set as
+MDRO value. Otherwise, the second rule will be tried and so on. The
+maximum number of rules is unlimited.</p>
+<p>You can print the rules set in the console for an overview. Colours
+will help reading it if your console supports colours.</p>
+<div class="sourceCode" id="cb2"><pre class="downlit sourceCode r">
+<code class="sourceCode R"><span><span class="va">custom</span></span>
+<span><span class="co">#&gt; A set of custom MDRO rules:</span></span>
+<span><span class="co">#&gt;   1. If CIP is "R" and age is higher than 60 then: Elderly Type A</span></span>
+<span><span class="co">#&gt;   2. If ERY is "R" and age is higher than 60 then: Elderly Type B</span></span>
+<span><span class="co">#&gt;   3. Otherwise: Negative</span></span>
+<span><span class="co">#&gt; </span></span>
+<span><span class="co">#&gt; Unmatched rows will return NA.</span></span>
+<span><span class="co">#&gt; Results will be of class 'factor', with ordered levels: Negative &lt; Elderly Type A &lt; Elderly Type B</span></span></code></pre></div>
+<p>The outcome of the function can be used for the
+<code>guideline</code> argument in the <code><a href="../reference/mdro.html">mdro()</a></code> function:</p>
+<div class="sourceCode" id="cb3"><pre class="downlit sourceCode r">
+<code class="sourceCode R"><span><span class="va">x</span> <span class="op">&lt;-</span> <span class="fu"><a href="../reference/mdro.html">mdro</a></span><span class="op">(</span><span class="va">example_isolates</span>, guideline <span class="op">=</span> <span class="va">custom</span><span class="op">)</span></span>
+<span><span class="fu"><a href="https://rdrr.io/r/base/table.html" class="external-link">table</a></span><span class="op">(</span><span class="va">x</span><span class="op">)</span></span>
+<span><span class="co">#&gt; x</span></span>
+<span><span class="co">#&gt;       Negative Elderly Type A Elderly Type B </span></span>
+<span><span class="co">#&gt;           1070            198            732</span></span></code></pre></div>
+<p>The rules set (the <code>custom</code> object in this case) could be
+exported to a shared file location using <code><a href="https://rdrr.io/r/base/readRDS.html" class="external-link">saveRDS()</a></code> if you
+collaborate with multiple users. The custom rules set could then be
+imported using <code><a href="https://rdrr.io/r/base/readRDS.html" class="external-link">readRDS()</a></code>.</p>
+</div>
+</div>
+<div class="section level3">
+<h3 id="examples">Examples<a class="anchor" aria-label="anchor" href="#examples"></a>
+</h3>
+<p>The <code><a href="../reference/mdro.html">mdro()</a></code> function always returns an ordered
+<code>factor</code> for predefined guidelines. For example, the output
+of the default guideline by Magiorakos <em>et al.</em> returns a
+<code>factor</code> with levels ‘Negative’, ‘MDR’, ‘XDR’ or ‘PDR’ in
+that order.</p>
+<p>The next example uses the <code>example_isolates</code> data set.
+This is a data set included with this package and contains full
+antibiograms of 2,000 microbial isolates. It reflects reality and can be
+used to practise AMR data analysis. If we test the MDR/XDR/PDR guideline
+on this data set, we get:</p>
+<div class="sourceCode" id="cb4"><pre class="downlit sourceCode r">
+<code class="sourceCode R"><span><span class="kw"><a href="https://rdrr.io/r/base/library.html" class="external-link">library</a></span><span class="op">(</span><span class="va"><a href="https://dplyr.tidyverse.org" class="external-link">dplyr</a></span><span class="op">)</span> <span class="co"># to support pipes: %&gt;%</span></span>
+<span><span class="kw"><a href="https://rdrr.io/r/base/library.html" class="external-link">library</a></span><span class="op">(</span><span class="va"><a href="https://msberends.github.io/cleaner/" class="external-link">cleaner</a></span><span class="op">)</span> <span class="co"># to create frequency tables</span></span></code></pre></div>
+<div class="sourceCode" id="cb5"><pre class="downlit sourceCode r">
+<code class="sourceCode R"><span><span class="va">example_isolates</span> <span class="op"><a href="https://magrittr.tidyverse.org/reference/pipe.html" class="external-link">%&gt;%</a></span></span>
+<span>  <span class="fu"><a href="../reference/mdro.html">mdro</a></span><span class="op">(</span><span class="op">)</span> <span class="op"><a href="https://magrittr.tidyverse.org/reference/pipe.html" class="external-link">%&gt;%</a></span></span>
+<span>  <span class="fu"><a href="https://msberends.github.io/cleaner/reference/freq.html" class="external-link">freq</a></span><span class="op">(</span><span class="op">)</span> <span class="co"># show frequency table of the result</span></span>
+<span><span class="co">#&gt; Warning: in mdro(): NA introduced for isolates where the available percentage of</span></span>
+<span><span class="co">#&gt; antimicrobial classes was below 50% (set with pct_required_classes)</span></span></code></pre></div>
+<p><strong>Frequency table</strong></p>
+<p>Class: factor &gt; ordered (numeric)<br>
+Length: 2,000<br>
+Levels: 4: Negative &lt; Multi-drug-resistant (MDR) &lt; Extensively
+drug-resistant …<br>
+Available: 1,729 (86.45%, NA: 271 = 13.55%)<br>
+Unique: 2</p>
+<table style="width:100%;" class="table">
+<colgroup>
+<col width="4%">
+<col width="38%">
+<col width="9%">
+<col width="12%">
+<col width="16%">
+<col width="19%">
+</colgroup>
+<thead><tr class="header">
+<th align="left"></th>
+<th align="left">Item</th>
+<th align="right">Count</th>
+<th align="right">Percent</th>
+<th align="right">Cum. Count</th>
+<th align="right">Cum. Percent</th>
+</tr></thead>
+<tbody>
+<tr class="odd">
+<td align="left">1</td>
+<td align="left">Negative</td>
+<td align="right">1601</td>
+<td align="right">92.6%</td>
+<td align="right">1601</td>
+<td align="right">92.6%</td>
+</tr>
+<tr class="even">
+<td align="left">2</td>
+<td align="left">Multi-drug-resistant (MDR)</td>
+<td align="right">128</td>
+<td align="right">7.4%</td>
+<td align="right">1729</td>
+<td align="right">100.0%</td>
+</tr>
+</tbody>
+</table>
+<p>For another example, I will create a data set to determine multi-drug
+resistant TB:</p>
+<div class="sourceCode" id="cb6"><pre class="downlit sourceCode r">
+<code class="sourceCode R"><span><span class="co"># random_sir() is a helper function to generate</span></span>
+<span><span class="co"># a random vector with values S, I and R</span></span>
+<span><span class="va">my_TB_data</span> <span class="op">&lt;-</span> <span class="fu"><a href="https://rdrr.io/r/base/data.frame.html" class="external-link">data.frame</a></span><span class="op">(</span></span>
+<span>  rifampicin <span class="op">=</span> <span class="fu"><a href="../reference/random.html">random_sir</a></span><span class="op">(</span><span class="fl">5000</span><span class="op">)</span>,</span>
+<span>  isoniazid <span class="op">=</span> <span class="fu"><a href="../reference/random.html">random_sir</a></span><span class="op">(</span><span class="fl">5000</span><span class="op">)</span>,</span>
+<span>  gatifloxacin <span class="op">=</span> <span class="fu"><a href="../reference/random.html">random_sir</a></span><span class="op">(</span><span class="fl">5000</span><span class="op">)</span>,</span>
+<span>  ethambutol <span class="op">=</span> <span class="fu"><a href="../reference/random.html">random_sir</a></span><span class="op">(</span><span class="fl">5000</span><span class="op">)</span>,</span>
+<span>  pyrazinamide <span class="op">=</span> <span class="fu"><a href="../reference/random.html">random_sir</a></span><span class="op">(</span><span class="fl">5000</span><span class="op">)</span>,</span>
+<span>  moxifloxacin <span class="op">=</span> <span class="fu"><a href="../reference/random.html">random_sir</a></span><span class="op">(</span><span class="fl">5000</span><span class="op">)</span>,</span>
+<span>  kanamycin <span class="op">=</span> <span class="fu"><a href="../reference/random.html">random_sir</a></span><span class="op">(</span><span class="fl">5000</span><span class="op">)</span></span>
+<span><span class="op">)</span></span></code></pre></div>
+<p>Because all column names are automatically verified for valid drug
+names or codes, this would have worked exactly the same way:</p>
+<div class="sourceCode" id="cb7"><pre class="downlit sourceCode r">
+<code class="sourceCode R"><span><span class="va">my_TB_data</span> <span class="op">&lt;-</span> <span class="fu"><a href="https://rdrr.io/r/base/data.frame.html" class="external-link">data.frame</a></span><span class="op">(</span></span>
+<span>  RIF <span class="op">=</span> <span class="fu"><a href="../reference/random.html">random_sir</a></span><span class="op">(</span><span class="fl">5000</span><span class="op">)</span>,</span>
+<span>  INH <span class="op">=</span> <span class="fu"><a href="../reference/random.html">random_sir</a></span><span class="op">(</span><span class="fl">5000</span><span class="op">)</span>,</span>
+<span>  GAT <span class="op">=</span> <span class="fu"><a href="../reference/random.html">random_sir</a></span><span class="op">(</span><span class="fl">5000</span><span class="op">)</span>,</span>
+<span>  ETH <span class="op">=</span> <span class="fu"><a href="../reference/random.html">random_sir</a></span><span class="op">(</span><span class="fl">5000</span><span class="op">)</span>,</span>
+<span>  PZA <span class="op">=</span> <span class="fu"><a href="../reference/random.html">random_sir</a></span><span class="op">(</span><span class="fl">5000</span><span class="op">)</span>,</span>
+<span>  MFX <span class="op">=</span> <span class="fu"><a href="../reference/random.html">random_sir</a></span><span class="op">(</span><span class="fl">5000</span><span class="op">)</span>,</span>
+<span>  KAN <span class="op">=</span> <span class="fu"><a href="../reference/random.html">random_sir</a></span><span class="op">(</span><span class="fl">5000</span><span class="op">)</span></span>
+<span><span class="op">)</span></span></code></pre></div>
+<p>The data set now looks like this:</p>
+<div class="sourceCode" id="cb8"><pre class="downlit sourceCode r">
+<code class="sourceCode R"><span><span class="fu"><a href="https://rdrr.io/r/utils/head.html" class="external-link">head</a></span><span class="op">(</span><span class="va">my_TB_data</span><span class="op">)</span></span>
+<span><span class="co">#&gt;   rifampicin isoniazid gatifloxacin ethambutol pyrazinamide moxifloxacin</span></span>
+<span><span class="co">#&gt; 1          I         R            S          S            S            S</span></span>
+<span><span class="co">#&gt; 2          S         S            I          R            R            S</span></span>
+<span><span class="co">#&gt; 3          R         I            I          I            R            I</span></span>
+<span><span class="co">#&gt; 4          I         S            S          S            S            S</span></span>
+<span><span class="co">#&gt; 5          I         I            I          S            I            S</span></span>
+<span><span class="co">#&gt; 6          R         S            R          S            I            I</span></span>
+<span><span class="co">#&gt;   kanamycin</span></span>
+<span><span class="co">#&gt; 1         R</span></span>
+<span><span class="co">#&gt; 2         I</span></span>
+<span><span class="co">#&gt; 3         S</span></span>
+<span><span class="co">#&gt; 4         I</span></span>
+<span><span class="co">#&gt; 5         I</span></span>
+<span><span class="co">#&gt; 6         I</span></span></code></pre></div>
+<p>We can now add the interpretation of MDR-TB to our data set. You can
+use:</p>
+<div class="sourceCode" id="cb9"><pre class="downlit sourceCode r">
+<code class="sourceCode R"><span><span class="fu"><a href="../reference/mdro.html">mdro</a></span><span class="op">(</span><span class="va">my_TB_data</span>, guideline <span class="op">=</span> <span class="st">"TB"</span><span class="op">)</span></span></code></pre></div>
+<p>or its shortcut <code><a href="../reference/mdro.html">mdr_tb()</a></code>:</p>
+<div class="sourceCode" id="cb10"><pre class="downlit sourceCode r">
+<code class="sourceCode R"><span><span class="va">my_TB_data</span><span class="op">$</span><span class="va">mdr</span> <span class="op">&lt;-</span> <span class="fu"><a href="../reference/mdro.html">mdr_tb</a></span><span class="op">(</span><span class="va">my_TB_data</span><span class="op">)</span></span>
+<span><span class="co">#&gt; ℹ No column found as input for col_mo, assuming all rows contain</span></span>
+<span><span class="co">#&gt;   Mycobacterium tuberculosis.</span></span></code></pre></div>
+<p>Create a frequency table of the results:</p>
+<div class="sourceCode" id="cb11"><pre class="downlit sourceCode r">
+<code class="sourceCode R"><span><span class="fu"><a href="https://msberends.github.io/cleaner/reference/freq.html" class="external-link">freq</a></span><span class="op">(</span><span class="va">my_TB_data</span><span class="op">$</span><span class="va">mdr</span><span class="op">)</span></span></code></pre></div>
+<p><strong>Frequency table</strong></p>
+<p>Class: factor &gt; ordered (numeric)<br>
+Length: 5,000<br>
+Levels: 5: Negative &lt; Mono-resistant &lt; Poly-resistant &lt;
+Multi-drug-resistant &lt;…<br>
+Available: 5,000 (100%, NA: 0 = 0%)<br>
+Unique: 5</p>
+<table style="width:100%;" class="table">
+<colgroup>
+<col width="4%">
+<col width="38%">
+<col width="9%">
+<col width="12%">
+<col width="16%">
+<col width="19%">
+</colgroup>
+<thead><tr class="header">
+<th align="left"></th>
+<th align="left">Item</th>
+<th align="right">Count</th>
+<th align="right">Percent</th>
+<th align="right">Cum. Count</th>
+<th align="right">Cum. Percent</th>
+</tr></thead>
+<tbody>
+<tr class="odd">
+<td align="left">1</td>
+<td align="left">Mono-resistant</td>
+<td align="right">3223</td>
+<td align="right">64.46%</td>
+<td align="right">3223</td>
+<td align="right">64.46%</td>
+</tr>
+<tr class="even">
+<td align="left">2</td>
+<td align="left">Negative</td>
+<td align="right">967</td>
+<td align="right">19.34%</td>
+<td align="right">4190</td>
+<td align="right">83.80%</td>
+</tr>
+<tr class="odd">
+<td align="left">3</td>
+<td align="left">Multi-drug-resistant</td>
+<td align="right">454</td>
+<td align="right">9.08%</td>
+<td align="right">4644</td>
+<td align="right">92.88%</td>
+</tr>
+<tr class="even">
+<td align="left">4</td>
+<td align="left">Poly-resistant</td>
+<td align="right">245</td>
+<td align="right">4.90%</td>
+<td align="right">4889</td>
+<td align="right">97.78%</td>
+</tr>
+<tr class="odd">
+<td align="left">5</td>
+<td align="left">Extensively drug-resistant</td>
+<td align="right">111</td>
+<td align="right">2.22%</td>
+<td align="right">5000</td>
+<td align="right">100.00%</td>
+</tr>
+</tbody>
+</table>
+</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>

articles/PCA.html

@@ -0,0 +1,244 @@
+<!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>How to conduct principal component analysis (PCA) for 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.4.2/css/all.min.css" rel="stylesheet">
+<link href="../deps/font-awesome-6.4.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="How to conduct principal component analysis (PCA) for AMR">
+</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.9084</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="active 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="../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="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-article">
+
+
+
+
+<div class="row">
+  <main id="main" class="col-md-9"><div class="page-header">
+      <img src="../logo.svg" class="logo" alt=""><h1>How to conduct principal component analysis (PCA) for AMR</h1>
+            
+      
+      <small class="dont-index">Source: <a href="https://github.com/msberends/AMR/blob/main/vignettes/PCA.Rmd" class="external-link"><code>vignettes/PCA.Rmd</code></a></small>
+      <div class="d-none name"><code>PCA.Rmd</code></div>
+    </div>
+
+    
+    
+<p><strong>NOTE: This page will be updated soon, as the pca() function
+is currently being developed.</strong></p>
+<div class="section level2">
+<h2 id="introduction">Introduction<a class="anchor" aria-label="anchor" href="#introduction"></a>
+</h2>
+</div>
+<div class="section level2">
+<h2 id="transforming">Transforming<a class="anchor" aria-label="anchor" href="#transforming"></a>
+</h2>
+<p>For PCA, we need to transform our AMR data first. This is what the
+<code>example_isolates</code> data set in this package looks like:</p>
+<div class="sourceCode" id="cb1"><pre class="downlit sourceCode r">
+<code class="sourceCode R"><span><span class="kw"><a href="https://rdrr.io/r/base/library.html" class="external-link">library</a></span><span class="op">(</span><span class="va"><a href="https://msberends.github.io/AMR/">AMR</a></span><span class="op">)</span></span>
+<span><span class="kw"><a href="https://rdrr.io/r/base/library.html" class="external-link">library</a></span><span class="op">(</span><span class="va"><a href="https://dplyr.tidyverse.org" class="external-link">dplyr</a></span><span class="op">)</span></span>
+<span><span class="fu"><a href="https://pillar.r-lib.org/reference/glimpse.html" class="external-link">glimpse</a></span><span class="op">(</span><span class="va">example_isolates</span><span class="op">)</span></span>
+<span><span class="co">#&gt; Rows: 2,000</span></span>
+<span><span class="co">#&gt; Columns: 46</span></span>
+<span><span class="co">#&gt; $ date    <span style="color: #949494; font-style: italic;">&lt;date&gt;</span> 2002-01-02, 2002-01-03, 2002-01-07, 2002-01-07, 2002-01-13, 2…</span></span>
+<span><span class="co">#&gt; $ patient <span style="color: #949494; font-style: italic;">&lt;chr&gt;</span> "A77334", "A77334", "067927", "067927", "067927", "067927", "4…</span></span>
+<span><span class="co">#&gt; $ age     <span style="color: #949494; font-style: italic;">&lt;dbl&gt;</span> 65, 65, 45, 45, 45, 45, 78, 78, 45, 79, 67, 67, 71, 71, 75, 50…</span></span>
+<span><span class="co">#&gt; $ gender  <span style="color: #949494; font-style: italic;">&lt;chr&gt;</span> "F", "F", "F", "F", "F", "F", "M", "M", "F", "F", "M", "M", "M…</span></span>
+<span><span class="co">#&gt; $ ward    <span style="color: #949494; font-style: italic;">&lt;chr&gt;</span> "Clinical", "Clinical", "ICU", "ICU", "ICU", "ICU", "Clinical"…</span></span>
+<span><span class="co">#&gt; $ mo      <span style="color: #949494; font-style: italic;">&lt;mo&gt;</span> "B_ESCHR_COLI", "B_ESCHR_COLI", "B_STPHY_EPDR", "B_STPHY_EPDR",…</span></span>
+<span><span class="co">#&gt; $ PEN     <span style="color: #949494; font-style: italic;">&lt;sir&gt;</span> R, R, R, R, R, R, R, R, R, R, R, R, R, R, R, R, R, R, R, R, S,…</span></span>
+<span><span class="co">#&gt; $ OXA     <span style="color: #949494; font-style: italic;">&lt;sir&gt;</span> NA, NA, NA, NA, NA, NA, NA, NA, NA, NA, NA, NA, NA, NA, NA, NA…</span></span>
+<span><span class="co">#&gt; $ FLC     <span style="color: #949494; font-style: italic;">&lt;sir&gt;</span> NA, NA, R, R, R, R, S, S, R, S, S, S, NA, NA, NA, NA, NA, R, R…</span></span>
+<span><span class="co">#&gt; $ AMX     <span style="color: #949494; font-style: italic;">&lt;sir&gt;</span> NA, NA, NA, NA, NA, NA, R, R, NA, NA, NA, NA, NA, NA, R, NA, N…</span></span>
+<span><span class="co">#&gt; $ AMC     <span style="color: #949494; font-style: italic;">&lt;sir&gt;</span> I, I, NA, NA, NA, NA, S, S, NA, NA, S, S, I, I, R, I, I, NA, N…</span></span>
+<span><span class="co">#&gt; $ AMP     <span style="color: #949494; font-style: italic;">&lt;sir&gt;</span> NA, NA, NA, NA, NA, NA, R, R, NA, NA, NA, NA, NA, NA, R, NA, N…</span></span>
+<span><span class="co">#&gt; $ TZP     <span style="color: #949494; font-style: italic;">&lt;sir&gt;</span> NA, NA, NA, NA, NA, NA, NA, NA, NA, NA, NA, NA, NA, NA, NA, NA…</span></span>
+<span><span class="co">#&gt; $ CZO     <span style="color: #949494; font-style: italic;">&lt;sir&gt;</span> NA, NA, NA, NA, NA, NA, NA, NA, NA, NA, NA, NA, NA, NA, R, NA,…</span></span>
+<span><span class="co">#&gt; $ FEP     <span style="color: #949494; font-style: italic;">&lt;sir&gt;</span> NA, NA, NA, NA, NA, NA, NA, NA, NA, NA, NA, NA, NA, NA, NA, NA…</span></span>
+<span><span class="co">#&gt; $ CXM     <span style="color: #949494; font-style: italic;">&lt;sir&gt;</span> I, I, R, R, R, R, S, S, R, S, S, S, S, S, NA, S, S, R, R, S, S…</span></span>
+<span><span class="co">#&gt; $ FOX     <span style="color: #949494; font-style: italic;">&lt;sir&gt;</span> NA, NA, NA, NA, NA, NA, NA, NA, NA, NA, NA, NA, NA, NA, R, NA,…</span></span>
+<span><span class="co">#&gt; $ CTX     <span style="color: #949494; font-style: italic;">&lt;sir&gt;</span> NA, NA, NA, NA, NA, NA, NA, NA, NA, NA, NA, NA, S, S, NA, S, S…</span></span>
+<span><span class="co">#&gt; $ CAZ     <span style="color: #949494; font-style: italic;">&lt;sir&gt;</span> NA, NA, R, R, R, R, R, R, R, R, R, R, NA, NA, NA, S, S, R, R, …</span></span>
+<span><span class="co">#&gt; $ CRO     <span style="color: #949494; font-style: italic;">&lt;sir&gt;</span> NA, NA, NA, NA, NA, NA, NA, NA, NA, NA, NA, NA, S, S, NA, S, S…</span></span>
+<span><span class="co">#&gt; $ GEN     <span style="color: #949494; font-style: italic;">&lt;sir&gt;</span> NA, NA, NA, NA, NA, NA, NA, NA, NA, NA, NA, NA, NA, NA, NA, NA…</span></span>
+<span><span class="co">#&gt; $ TOB     <span style="color: #949494; font-style: italic;">&lt;sir&gt;</span> NA, NA, NA, NA, NA, NA, S, S, NA, NA, NA, NA, S, S, NA, NA, NA…</span></span>
+<span><span class="co">#&gt; $ AMK     <span style="color: #949494; font-style: italic;">&lt;sir&gt;</span> NA, NA, NA, NA, NA, NA, NA, NA, NA, NA, NA, NA, NA, NA, NA, NA…</span></span>
+<span><span class="co">#&gt; $ KAN     <span style="color: #949494; font-style: italic;">&lt;sir&gt;</span> NA, NA, NA, NA, NA, NA, NA, NA, NA, NA, NA, NA, NA, NA, NA, NA…</span></span>
+<span><span class="co">#&gt; $ TMP     <span style="color: #949494; font-style: italic;">&lt;sir&gt;</span> R, R, S, S, R, R, R, R, S, S, NA, NA, S, S, S, S, S, R, R, R, …</span></span>
+<span><span class="co">#&gt; $ SXT     <span style="color: #949494; font-style: italic;">&lt;sir&gt;</span> R, R, S, S, NA, NA, NA, NA, S, S, NA, NA, S, S, S, S, S, NA, N…</span></span>
+<span><span class="co">#&gt; $ NIT     <span style="color: #949494; font-style: italic;">&lt;sir&gt;</span> NA, NA, NA, NA, NA, NA, NA, NA, NA, NA, NA, NA, NA, NA, NA, R,…</span></span>
+<span><span class="co">#&gt; $ FOS     <span style="color: #949494; font-style: italic;">&lt;sir&gt;</span> NA, NA, NA, NA, NA, NA, NA, NA, NA, NA, NA, NA, NA, NA, NA, NA…</span></span>
+<span><span class="co">#&gt; $ LNZ     <span style="color: #949494; font-style: italic;">&lt;sir&gt;</span> R, R, NA, NA, NA, NA, NA, NA, NA, NA, NA, NA, R, R, R, R, R, N…</span></span>
+<span><span class="co">#&gt; $ CIP     <span style="color: #949494; font-style: italic;">&lt;sir&gt;</span> NA, NA, NA, NA, NA, NA, NA, NA, S, S, NA, NA, NA, NA, NA, S, S…</span></span>
+<span><span class="co">#&gt; $ MFX     <span style="color: #949494; font-style: italic;">&lt;sir&gt;</span> NA, NA, NA, NA, NA, NA, NA, NA, NA, NA, NA, NA, NA, NA, NA, NA…</span></span>
+<span><span class="co">#&gt; $ VAN     <span style="color: #949494; font-style: italic;">&lt;sir&gt;</span> R, R, S, S, S, S, S, S, S, S, NA, NA, R, R, R, R, R, S, S, S, …</span></span>
+<span><span class="co">#&gt; $ TEC     <span style="color: #949494; font-style: italic;">&lt;sir&gt;</span> R, R, NA, NA, NA, NA, NA, NA, NA, NA, NA, NA, R, R, R, R, R, N…</span></span>
+<span><span class="co">#&gt; $ TCY     <span style="color: #949494; font-style: italic;">&lt;sir&gt;</span> R, R, S, S, S, S, S, S, S, I, S, S, NA, NA, I, R, R, S, I, R, …</span></span>
+<span><span class="co">#&gt; $ TGC     <span style="color: #949494; font-style: italic;">&lt;sir&gt;</span> NA, NA, S, S, S, S, S, S, S, NA, S, S, NA, NA, NA, R, R, S, NA…</span></span>
+<span><span class="co">#&gt; $ DOX     <span style="color: #949494; font-style: italic;">&lt;sir&gt;</span> NA, NA, S, S, S, S, S, S, S, NA, S, S, NA, NA, NA, R, R, S, NA…</span></span>
+<span><span class="co">#&gt; $ ERY     <span style="color: #949494; font-style: italic;">&lt;sir&gt;</span> R, R, R, R, R, R, S, S, R, S, S, S, R, R, R, R, R, R, R, R, S,…</span></span>
+<span><span class="co">#&gt; $ CLI     <span style="color: #949494; font-style: italic;">&lt;sir&gt;</span> R, R, NA, NA, NA, R, NA, NA, NA, NA, NA, NA, R, R, R, R, R, NA…</span></span>
+<span><span class="co">#&gt; $ AZM     <span style="color: #949494; font-style: italic;">&lt;sir&gt;</span> R, R, R, R, R, R, S, S, R, S, S, S, R, R, R, R, R, R, R, R, S,…</span></span>
+<span><span class="co">#&gt; $ IPM     <span style="color: #949494; font-style: italic;">&lt;sir&gt;</span> NA, NA, NA, NA, NA, NA, NA, NA, NA, NA, NA, NA, S, S, NA, S, S…</span></span>
+<span><span class="co">#&gt; $ MEM     <span style="color: #949494; font-style: italic;">&lt;sir&gt;</span> NA, NA, NA, NA, NA, NA, NA, NA, NA, NA, NA, NA, NA, NA, NA, NA…</span></span>
+<span><span class="co">#&gt; $ MTR     <span style="color: #949494; font-style: italic;">&lt;sir&gt;</span> NA, NA, NA, NA, NA, NA, NA, NA, NA, NA, NA, NA, NA, NA, NA, NA…</span></span>
+<span><span class="co">#&gt; $ CHL     <span style="color: #949494; font-style: italic;">&lt;sir&gt;</span> NA, NA, NA, NA, NA, NA, NA, NA, NA, NA, NA, NA, NA, NA, NA, NA…</span></span>
+<span><span class="co">#&gt; $ COL     <span style="color: #949494; font-style: italic;">&lt;sir&gt;</span> NA, NA, R, R, R, R, R, R, R, R, R, R, NA, NA, NA, R, R, R, R, …</span></span>
+<span><span class="co">#&gt; $ MUP     <span style="color: #949494; font-style: italic;">&lt;sir&gt;</span> NA, NA, NA, NA, NA, NA, NA, NA, NA, NA, NA, NA, NA, NA, NA, NA…</span></span>
+<span><span class="co">#&gt; $ RIF     <span style="color: #949494; font-style: italic;">&lt;sir&gt;</span> R, R, NA, NA, NA, NA, NA, NA, NA, NA, NA, NA, R, R, R, R, R, N…</span></span></code></pre></div>
+<p>Now to transform this to a data set with only resistance percentages
+per taxonomic order and genus:</p>
+<div class="sourceCode" id="cb2"><pre class="downlit sourceCode r">
+<code class="sourceCode R"><span><span class="va">resistance_data</span> <span class="op">&lt;-</span> <span class="va">example_isolates</span> <span class="op"><a href="https://magrittr.tidyverse.org/reference/pipe.html" class="external-link">%&gt;%</a></span></span>
+<span>  <span class="fu"><a href="https://dplyr.tidyverse.org/reference/group_by.html" class="external-link">group_by</a></span><span class="op">(</span></span>
+<span>    order <span class="op">=</span> <span class="fu"><a href="../reference/mo_property.html">mo_order</a></span><span class="op">(</span><span class="va">mo</span><span class="op">)</span>, <span class="co"># group on anything, like order</span></span>
+<span>    genus <span class="op">=</span> <span class="fu"><a href="../reference/mo_property.html">mo_genus</a></span><span class="op">(</span><span class="va">mo</span><span class="op">)</span></span>
+<span>  <span class="op">)</span> <span class="op"><a href="https://magrittr.tidyverse.org/reference/pipe.html" class="external-link">%&gt;%</a></span> <span class="co">#  and genus as we do here</span></span>
+<span>  <span class="fu"><a href="https://dplyr.tidyverse.org/reference/summarise_all.html" class="external-link">summarise_if</a></span><span class="op">(</span><span class="va">is.sir</span>, <span class="va">resistance</span><span class="op">)</span> <span class="op"><a href="https://magrittr.tidyverse.org/reference/pipe.html" class="external-link">%&gt;%</a></span> <span class="co"># then get resistance of all drugs</span></span>
+<span>  <span class="fu"><a href="https://dplyr.tidyverse.org/reference/select.html" class="external-link">select</a></span><span class="op">(</span></span>
+<span>    <span class="va">order</span>, <span class="va">genus</span>, <span class="va">AMC</span>, <span class="va">CXM</span>, <span class="va">CTX</span>,</span>
+<span>    <span class="va">CAZ</span>, <span class="va">GEN</span>, <span class="va">TOB</span>, <span class="va">TMP</span>, <span class="va">SXT</span></span>
+<span>  <span class="op">)</span> <span class="co"># and select only relevant columns</span></span>
+<span></span>
+<span><span class="fu"><a href="https://rdrr.io/r/utils/head.html" class="external-link">head</a></span><span class="op">(</span><span class="va">resistance_data</span><span class="op">)</span></span>
+<span><span class="co">#&gt; <span style="color: #949494;"># A tibble: 6 × 10</span></span></span>
+<span><span class="co">#&gt; <span style="color: #949494;"># Groups:   order [5]</span></span></span>
+<span><span class="co">#&gt;   order             genus          AMC   CXM   CTX   CAZ   GEN   TOB   TMP   SXT</span></span>
+<span><span class="co">#&gt;   <span style="color: #949494; font-style: italic;">&lt;chr&gt;</span>             <span style="color: #949494; font-style: italic;">&lt;chr&gt;</span>        <span style="color: #949494; font-style: italic;">&lt;dbl&gt;</span> <span style="color: #949494; font-style: italic;">&lt;dbl&gt;</span> <span style="color: #949494; font-style: italic;">&lt;dbl&gt;</span> <span style="color: #949494; font-style: italic;">&lt;dbl&gt;</span> <span style="color: #949494; font-style: italic;">&lt;dbl&gt;</span> <span style="color: #949494; font-style: italic;">&lt;dbl&gt;</span> <span style="color: #949494; font-style: italic;">&lt;dbl&gt;</span> <span style="color: #949494; font-style: italic;">&lt;dbl&gt;</span></span></span>
+<span><span class="co">#&gt; <span style="color: #BCBCBC;">1</span> (unknown order)   (unknown ge…    <span style="color: #BB0000;">NA</span>    <span style="color: #BB0000;">NA</span>    <span style="color: #BB0000;">NA</span>    <span style="color: #BB0000;">NA</span>    <span style="color: #BB0000;">NA</span>    <span style="color: #BB0000;">NA</span>    <span style="color: #BB0000;">NA</span>    <span style="color: #BB0000;">NA</span></span></span>
+<span><span class="co">#&gt; <span style="color: #BCBCBC;">2</span> Actinomycetales   Schaalia        <span style="color: #BB0000;">NA</span>    <span style="color: #BB0000;">NA</span>    <span style="color: #BB0000;">NA</span>    <span style="color: #BB0000;">NA</span>    <span style="color: #BB0000;">NA</span>    <span style="color: #BB0000;">NA</span>    <span style="color: #BB0000;">NA</span>    <span style="color: #BB0000;">NA</span></span></span>
+<span><span class="co">#&gt; <span style="color: #BCBCBC;">3</span> Bacteroidales     Bacteroides     <span style="color: #BB0000;">NA</span>    <span style="color: #BB0000;">NA</span>    <span style="color: #BB0000;">NA</span>    <span style="color: #BB0000;">NA</span>    <span style="color: #BB0000;">NA</span>    <span style="color: #BB0000;">NA</span>    <span style="color: #BB0000;">NA</span>    <span style="color: #BB0000;">NA</span></span></span>
+<span><span class="co">#&gt; <span style="color: #BCBCBC;">4</span> Campylobacterales Campylobact…    <span style="color: #BB0000;">NA</span>    <span style="color: #BB0000;">NA</span>    <span style="color: #BB0000;">NA</span>    <span style="color: #BB0000;">NA</span>    <span style="color: #BB0000;">NA</span>    <span style="color: #BB0000;">NA</span>    <span style="color: #BB0000;">NA</span>    <span style="color: #BB0000;">NA</span></span></span>
+<span><span class="co">#&gt; <span style="color: #BCBCBC;">5</span> Caryophanales     Gemella         <span style="color: #BB0000;">NA</span>    <span style="color: #BB0000;">NA</span>    <span style="color: #BB0000;">NA</span>    <span style="color: #BB0000;">NA</span>    <span style="color: #BB0000;">NA</span>    <span style="color: #BB0000;">NA</span>    <span style="color: #BB0000;">NA</span>    <span style="color: #BB0000;">NA</span></span></span>
+<span><span class="co">#&gt; <span style="color: #BCBCBC;">6</span> Caryophanales     Listeria        <span style="color: #BB0000;">NA</span>    <span style="color: #BB0000;">NA</span>    <span style="color: #BB0000;">NA</span>    <span style="color: #BB0000;">NA</span>    <span style="color: #BB0000;">NA</span>    <span style="color: #BB0000;">NA</span>    <span style="color: #BB0000;">NA</span>    <span style="color: #BB0000;">NA</span></span></span></code></pre></div>
+</div>
+<div class="section level2">
+<h2 id="perform-principal-component-analysis">Perform principal component analysis<a class="anchor" aria-label="anchor" href="#perform-principal-component-analysis"></a>
+</h2>
+<p>The new <code><a href="../reference/pca.html">pca()</a></code> function will automatically filter on rows
+that contain numeric values in all selected variables, so we now only
+need to do:</p>
+<div class="sourceCode" id="cb3"><pre class="downlit sourceCode r">
+<code class="sourceCode R"><span><span class="va">pca_result</span> <span class="op">&lt;-</span> <span class="fu"><a href="../reference/pca.html">pca</a></span><span class="op">(</span><span class="va">resistance_data</span><span class="op">)</span></span>
+<span><span class="co">#&gt; ℹ Columns selected for PCA: "AMC", "CAZ", "CTX", "CXM", "GEN", "SXT",</span></span>
+<span><span class="co">#&gt;   "TMP", and "TOB". Total observations available: 7.</span></span></code></pre></div>
+<p>The result can be reviewed with the good old <code><a href="https://rdrr.io/r/base/summary.html" class="external-link">summary()</a></code>
+function:</p>
+<div class="sourceCode" id="cb4"><pre class="downlit sourceCode r">
+<code class="sourceCode R"><span><span class="fu"><a href="https://rdrr.io/r/base/summary.html" class="external-link">summary</a></span><span class="op">(</span><span class="va">pca_result</span><span class="op">)</span></span>
+<span><span class="co">#&gt; Groups (n=4, named as 'order'):</span></span>
+<span><span class="co">#&gt; [1] "Caryophanales"    "Enterobacterales" "Lactobacillales"  "Pseudomonadales"</span></span>
+<span><span class="co">#&gt; Importance of components:</span></span>
+<span><span class="co">#&gt;                           PC1    PC2    PC3     PC4     PC5     PC6       PC7</span></span>
+<span><span class="co">#&gt; Standard deviation     2.1539 1.6807 0.6138 0.33879 0.20808 0.03140 1.232e-16</span></span>
+<span><span class="co">#&gt; Proportion of Variance 0.5799 0.3531 0.0471 0.01435 0.00541 0.00012 0.000e+00</span></span>
+<span><span class="co">#&gt; Cumulative Proportion  0.5799 0.9330 0.9801 0.99446 0.99988 1.00000 1.000e+00</span></span></code></pre></div>
+<pre><code><span><span class="co">#&gt; Groups (n=4, named as 'order'):</span></span>
+<span><span class="co">#&gt; [1] "Caryophanales"    "Enterobacterales" "Lactobacillales"  "Pseudomonadales"</span></span></code></pre>
+<p>Good news. The first two components explain a total of 93.3% of the
+variance (see the PC1 and PC2 values of the <em>Proportion of
+Variance</em>. We can create a so-called biplot with the base R
+<code><a href="https://rdrr.io/r/stats/biplot.html" class="external-link">biplot()</a></code> function, to see which antimicrobial resistance
+per drug explain the difference per microorganism.</p>
+</div>
+<div class="section level2">
+<h2 id="plotting-the-results">Plotting the results<a class="anchor" aria-label="anchor" href="#plotting-the-results"></a>
+</h2>
+<div class="sourceCode" id="cb6"><pre class="downlit sourceCode r">
+<code class="sourceCode R"><span><span class="fu"><a href="https://rdrr.io/r/stats/biplot.html" class="external-link">biplot</a></span><span class="op">(</span><span class="va">pca_result</span><span class="op">)</span></span></code></pre></div>
+<p><img src="PCA_files/figure-html/unnamed-chunk-5-1.png" width="750"></p>
+<p>But we can’t see the explanation of the points. Perhaps this works
+better with our new <code><a href="../reference/ggplot_pca.html">ggplot_pca()</a></code> function, that
+automatically adds the right labels and even groups:</p>
+<div class="sourceCode" id="cb7"><pre class="downlit sourceCode r">
+<code class="sourceCode R"><span><span class="fu"><a href="../reference/ggplot_pca.html">ggplot_pca</a></span><span class="op">(</span><span class="va">pca_result</span><span class="op">)</span></span></code></pre></div>
+<p><img src="PCA_files/figure-html/unnamed-chunk-6-1.png" width="750"></p>
+<p>You can also print an ellipse per group, and edit the appearance:</p>
+<div class="sourceCode" id="cb8"><pre class="downlit sourceCode r">
+<code class="sourceCode R"><span><span class="fu"><a href="../reference/ggplot_pca.html">ggplot_pca</a></span><span class="op">(</span><span class="va">pca_result</span>, ellipse <span class="op">=</span> <span class="cn">TRUE</span><span class="op">)</span> <span class="op">+</span></span>
+<span>  <span class="fu">ggplot2</span><span class="fu">::</span><span class="fu"><a href="https://ggplot2.tidyverse.org/reference/labs.html" class="external-link">labs</a></span><span class="op">(</span>title <span class="op">=</span> <span class="st">"An AMR/PCA biplot!"</span><span class="op">)</span></span></code></pre></div>
+<p><img src="PCA_files/figure-html/unnamed-chunk-7-1.png" width="750"></p>
+</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>

articles/WHONET.html

@@ -0,0 +1,334 @@
+<!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>How to work with WHONET data • 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.4.2/css/all.min.css" rel="stylesheet">
+<link href="../deps/font-awesome-6.4.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="How to work with WHONET data">
+</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.9084</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="active 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="../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="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-article">
+
+
+
+
+<div class="row">
+  <main id="main" class="col-md-9"><div class="page-header">
+      <img src="../logo.svg" class="logo" alt=""><h1>How to work with WHONET data</h1>
+            
+      
+      <small class="dont-index">Source: <a href="https://github.com/msberends/AMR/blob/main/vignettes/WHONET.Rmd" class="external-link"><code>vignettes/WHONET.Rmd</code></a></small>
+      <div class="d-none name"><code>WHONET.Rmd</code></div>
+    </div>
+
+    
+    
+<div class="section level3">
+<h3 id="import-of-data">Import of data<a class="anchor" aria-label="anchor" href="#import-of-data"></a>
+</h3>
+<p>This tutorial assumes you already imported the WHONET data with
+e.g. the <a href="https://readxl.tidyverse.org/" class="external-link"><code>readxl</code>
+package</a>. In RStudio, this can be done using the menu button ‘Import
+Dataset’ in the tab ‘Environment’. Choose the option ‘From Excel’ and
+select your exported file. Make sure date fields are imported
+correctly.</p>
+<p>An example syntax could look like this:</p>
+<div class="sourceCode" id="cb1"><pre class="downlit sourceCode r">
+<code class="sourceCode R"><span><span class="kw"><a href="https://rdrr.io/r/base/library.html" class="external-link">library</a></span><span class="op">(</span><span class="va"><a href="https://readxl.tidyverse.org" class="external-link">readxl</a></span><span class="op">)</span></span>
+<span><span class="va">data</span> <span class="op">&lt;-</span> <span class="fu"><a href="https://readxl.tidyverse.org/reference/read_excel.html" class="external-link">read_excel</a></span><span class="op">(</span>path <span class="op">=</span> <span class="st">"path/to/your/file.xlsx"</span><span class="op">)</span></span></code></pre></div>
+<p>This package comes with an <a href="https://msberends.github.io/AMR/reference/WHONET.html">example
+data set <code>WHONET</code></a>. We will use it for this analysis.</p>
+</div>
+<div class="section level3">
+<h3 id="preparation">Preparation<a class="anchor" aria-label="anchor" href="#preparation"></a>
+</h3>
+<p>First, load the relevant packages if you did not yet did this. I use
+the tidyverse for all of my analyses. All of them. If you don’t know it
+yet, I suggest you read about it on their website: <a href="https://www.tidyverse.org/" class="external-link uri">https://www.tidyverse.org/</a>.</p>
+<div class="sourceCode" id="cb2"><pre class="downlit sourceCode r">
+<code class="sourceCode R"><span><span class="kw"><a href="https://rdrr.io/r/base/library.html" class="external-link">library</a></span><span class="op">(</span><span class="va"><a href="https://dplyr.tidyverse.org" class="external-link">dplyr</a></span><span class="op">)</span> <span class="co"># part of tidyverse</span></span>
+<span><span class="kw"><a href="https://rdrr.io/r/base/library.html" class="external-link">library</a></span><span class="op">(</span><span class="va"><a href="https://ggplot2.tidyverse.org" class="external-link">ggplot2</a></span><span class="op">)</span> <span class="co"># part of tidyverse</span></span>
+<span><span class="kw"><a href="https://rdrr.io/r/base/library.html" class="external-link">library</a></span><span class="op">(</span><span class="va"><a href="https://msberends.github.io/AMR/">AMR</a></span><span class="op">)</span> <span class="co"># this package</span></span>
+<span><span class="kw"><a href="https://rdrr.io/r/base/library.html" class="external-link">library</a></span><span class="op">(</span><span class="va"><a href="https://msberends.github.io/cleaner/" class="external-link">cleaner</a></span><span class="op">)</span> <span class="co"># to create frequency tables</span></span></code></pre></div>
+<p>We will have to transform some variables to simplify and automate the
+analysis:</p>
+<ul>
+<li>Microorganisms should be transformed to our own microorganism codes
+(called an <code>mo</code>) using <a href="https://msberends.github.io/AMR/reference/catalogue_of_life">our
+Catalogue of Life reference data set</a>, which contains all ~70,000
+microorganisms from the taxonomic kingdoms Bacteria, Fungi and Protozoa.
+We do the tranformation with <code><a href="../reference/as.mo.html">as.mo()</a></code>. This function also
+recognises almost all WHONET abbreviations of microorganisms.</li>
+<li>Antimicrobial results or interpretations have to be clean and valid.
+In other words, they should only contain values <code>"S"</code>,
+<code>"I"</code> or <code>"R"</code>. That is exactly where the
+<code><a href="../reference/as.sir.html">as.sir()</a></code> function is for.</li>
+</ul>
+<div class="sourceCode" id="cb3"><pre class="downlit sourceCode r">
+<code class="sourceCode R"><span><span class="co"># transform variables</span></span>
+<span><span class="va">data</span> <span class="op">&lt;-</span> <span class="va">WHONET</span> <span class="op"><a href="https://magrittr.tidyverse.org/reference/pipe.html" class="external-link">%&gt;%</a></span></span>
+<span>  <span class="co"># get microbial ID based on given organism</span></span>
+<span>  <span class="fu"><a href="https://dplyr.tidyverse.org/reference/mutate.html" class="external-link">mutate</a></span><span class="op">(</span>mo <span class="op">=</span> <span class="fu"><a href="../reference/as.mo.html">as.mo</a></span><span class="op">(</span><span class="va">Organism</span><span class="op">)</span><span class="op">)</span> <span class="op"><a href="https://magrittr.tidyverse.org/reference/pipe.html" class="external-link">%&gt;%</a></span></span>
+<span>  <span class="co"># transform everything from "AMP_ND10" to "CIP_EE" to the new `sir` class</span></span>
+<span>  <span class="fu"><a href="https://dplyr.tidyverse.org/reference/mutate_all.html" class="external-link">mutate_at</a></span><span class="op">(</span><span class="fu"><a href="https://dplyr.tidyverse.org/reference/vars.html" class="external-link">vars</a></span><span class="op">(</span><span class="va">AMP_ND10</span><span class="op">:</span><span class="va">CIP_EE</span><span class="op">)</span>, <span class="va">as.sir</span><span class="op">)</span></span></code></pre></div>
+<p>No errors or warnings, so all values are transformed succesfully.</p>
+<p>We also created a package dedicated to data cleaning and checking,
+called the <code>cleaner</code> package. Its <code><a href="https://msberends.github.io/cleaner/reference/freq.html" class="external-link">freq()</a></code>
+function can be used to create frequency tables.</p>
+<p>So let’s check our data, with a couple of frequency tables:</p>
+<div class="sourceCode" id="cb4"><pre class="downlit sourceCode r">
+<code class="sourceCode R"><span><span class="co"># our newly created `mo` variable, put in the mo_name() function</span></span>
+<span><span class="va">data</span> <span class="op"><a href="https://magrittr.tidyverse.org/reference/pipe.html" class="external-link">%&gt;%</a></span> <span class="fu"><a href="https://msberends.github.io/cleaner/reference/freq.html" class="external-link">freq</a></span><span class="op">(</span><span class="fu"><a href="../reference/mo_property.html">mo_name</a></span><span class="op">(</span><span class="va">mo</span><span class="op">)</span>, nmax <span class="op">=</span> <span class="fl">10</span><span class="op">)</span></span></code></pre></div>
+<p><strong>Frequency table</strong></p>
+<p>Class: character<br>
+Length: 500<br>
+Available: 500 (100%, NA: 0 = 0%)<br>
+Unique: 38</p>
+<p>Shortest: 11<br>
+Longest: 40</p>
+<table class="table">
+<colgroup>
+<col width="4%">
+<col width="47%">
+<col width="7%">
+<col width="10%">
+<col width="13%">
+<col width="15%">
+</colgroup>
+<thead><tr class="header">
+<th align="left"></th>
+<th align="left">Item</th>
+<th align="right">Count</th>
+<th align="right">Percent</th>
+<th align="right">Cum. Count</th>
+<th align="right">Cum. Percent</th>
+</tr></thead>
+<tbody>
+<tr class="odd">
+<td align="left">1</td>
+<td align="left">Escherichia coli</td>
+<td align="right">245</td>
+<td align="right">49.0%</td>
+<td align="right">245</td>
+<td align="right">49.0%</td>
+</tr>
+<tr class="even">
+<td align="left">2</td>
+<td align="left">Coagulase-negative Staphylococcus (CoNS)</td>
+<td align="right">74</td>
+<td align="right">14.8%</td>
+<td align="right">319</td>
+<td align="right">63.8%</td>
+</tr>
+<tr class="odd">
+<td align="left">3</td>
+<td align="left">Staphylococcus epidermidis</td>
+<td align="right">38</td>
+<td align="right">7.6%</td>
+<td align="right">357</td>
+<td align="right">71.4%</td>
+</tr>
+<tr class="even">
+<td align="left">4</td>
+<td align="left">Streptococcus pneumoniae</td>
+<td align="right">31</td>
+<td align="right">6.2%</td>
+<td align="right">388</td>
+<td align="right">77.6%</td>
+</tr>
+<tr class="odd">
+<td align="left">5</td>
+<td align="left">Staphylococcus hominis</td>
+<td align="right">21</td>
+<td align="right">4.2%</td>
+<td align="right">409</td>
+<td align="right">81.8%</td>
+</tr>
+<tr class="even">
+<td align="left">6</td>
+<td align="left">Proteus mirabilis</td>
+<td align="right">9</td>
+<td align="right">1.8%</td>
+<td align="right">418</td>
+<td align="right">83.6%</td>
+</tr>
+<tr class="odd">
+<td align="left">7</td>
+<td align="left">Enterococcus faecium</td>
+<td align="right">8</td>
+<td align="right">1.6%</td>
+<td align="right">426</td>
+<td align="right">85.2%</td>
+</tr>
+<tr class="even">
+<td align="left">8</td>
+<td align="left">Staphylococcus capitis urealyticus</td>
+<td align="right">8</td>
+<td align="right">1.6%</td>
+<td align="right">434</td>
+<td align="right">86.8%</td>
+</tr>
+<tr class="odd">
+<td align="left">9</td>
+<td align="left">Enterobacter cloacae</td>
+<td align="right">5</td>
+<td align="right">1.0%</td>
+<td align="right">439</td>
+<td align="right">87.8%</td>
+</tr>
+<tr class="even">
+<td align="left">10</td>
+<td align="left">Enterococcus columbae</td>
+<td align="right">4</td>
+<td align="right">0.8%</td>
+<td align="right">443</td>
+<td align="right">88.6%</td>
+</tr>
+</tbody>
+</table>
+<p>(omitted 28 entries, n = 57 [11.4%])</p>
+<div class="sourceCode" id="cb5"><pre class="downlit sourceCode r">
+<code class="sourceCode R"><span><span class="co"># our transformed antibiotic columns</span></span>
+<span><span class="co"># amoxicillin/clavulanic acid (J01CR02) as an example</span></span>
+<span><span class="va">data</span> <span class="op"><a href="https://magrittr.tidyverse.org/reference/pipe.html" class="external-link">%&gt;%</a></span> <span class="fu"><a href="https://msberends.github.io/cleaner/reference/freq.html" class="external-link">freq</a></span><span class="op">(</span><span class="va">AMC_ND2</span><span class="op">)</span></span></code></pre></div>
+<p><strong>Frequency table</strong></p>
+<p>Class: factor &gt; ordered &gt; sir (numeric)<br>
+Length: 500<br>
+Levels: 5: S &lt; SDD &lt; I &lt; R &lt; NI<br>
+Available: 481 (96.2%, NA: 19 = 3.8%)<br>
+Unique: 3</p>
+<p>Drug: Amoxicillin/clavulanic acid (AMC, J01CR02)<br>
+Drug group: Beta-lactams/penicillins<br>
+%SI: 78.59%</p>
+<table class="table">
+<thead><tr class="header">
+<th align="left"></th>
+<th align="left">Item</th>
+<th align="right">Count</th>
+<th align="right">Percent</th>
+<th align="right">Cum. Count</th>
+<th align="right">Cum. Percent</th>
+</tr></thead>
+<tbody>
+<tr class="odd">
+<td align="left">1</td>
+<td align="left">S</td>
+<td align="right">356</td>
+<td align="right">74.01%</td>
+<td align="right">356</td>
+<td align="right">74.01%</td>
+</tr>
+<tr class="even">
+<td align="left">2</td>
+<td align="left">R</td>
+<td align="right">103</td>
+<td align="right">21.41%</td>
+<td align="right">459</td>
+<td align="right">95.43%</td>
+</tr>
+<tr class="odd">
+<td align="left">3</td>
+<td align="left">I</td>
+<td align="right">22</td>
+<td align="right">4.57%</td>
+<td align="right">481</td>
+<td align="right">100.00%</td>
+</tr>
+</tbody>
+</table>
+</div>
+<div class="section level3">
+<h3 id="a-first-glimpse-at-results">A first glimpse at results<a class="anchor" aria-label="anchor" href="#a-first-glimpse-at-results"></a>
+</h3>
+<p>An easy <code>ggplot</code> will already give a lot of information,
+using the included <code><a href="../reference/ggplot_sir.html">ggplot_sir()</a></code> function:</p>
+<div class="sourceCode" id="cb6"><pre class="downlit sourceCode r">
+<code class="sourceCode R"><span><span class="va">data</span> <span class="op"><a href="https://magrittr.tidyverse.org/reference/pipe.html" class="external-link">%&gt;%</a></span></span>
+<span>  <span class="fu"><a href="https://dplyr.tidyverse.org/reference/group_by.html" class="external-link">group_by</a></span><span class="op">(</span><span class="va">Country</span><span class="op">)</span> <span class="op"><a href="https://magrittr.tidyverse.org/reference/pipe.html" class="external-link">%&gt;%</a></span></span>
+<span>  <span class="fu"><a href="https://dplyr.tidyverse.org/reference/select.html" class="external-link">select</a></span><span class="op">(</span><span class="va">Country</span>, <span class="va">AMP_ND2</span>, <span class="va">AMC_ED20</span>, <span class="va">CAZ_ED10</span>, <span class="va">CIP_ED5</span><span class="op">)</span> <span class="op"><a href="https://magrittr.tidyverse.org/reference/pipe.html" class="external-link">%&gt;%</a></span></span>
+<span>  <span class="fu"><a href="../reference/ggplot_sir.html">ggplot_sir</a></span><span class="op">(</span>translate_ab <span class="op">=</span> <span class="st">"ab"</span>, facet <span class="op">=</span> <span class="st">"Country"</span>, datalabels <span class="op">=</span> <span class="cn">FALSE</span><span class="op">)</span></span></code></pre></div>
+<p><img src="WHONET_files/figure-html/unnamed-chunk-7-1.png" width="720"></p>
+</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>

articles/index.html

@@ -0,0 +1,91 @@
+<!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>Articles • 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.4.2/css/all.min.css" rel="stylesheet"><link href="../deps/font-awesome-6.4.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="Articles"><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.9084</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="../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="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-article-index">
+<div class="row">
+  <main id="main" class="col-md-9"><div class="page-header">
+      <img src="../logo.svg" class="logo" alt=""><h1>Articles</h1>
+    </div>
+
+    <div class="section ">
+      <h3>All vignettes</h3>
+      <div class="section-desc"></div>
+
+      <dl><dt><a href="AMR_for_Python.html">AMR for Python</a></dt>
+        <dd>
+        </dd><dt><a href="AMR.html">How to conduct AMR data analysis</a></dt>
+        <dd>
+        </dd><dt><a href="datasets.html">Data sets for download / own use</a></dt>
+        <dd>
+        </dd><dt><a href="EUCAST.html">How to apply EUCAST rules</a></dt>
+        <dd>
+        </dd><dt><a href="MDR.html">How to determine multi-drug resistance (MDR)</a></dt>
+        <dd>
+        </dd><dt><a href="other_pkg.html">Using AMR with other packages: AMR &amp; dplyr/tidyverse</a></dt>
+        <dd>
+        </dd><dt><a href="PCA.html">How to conduct principal component analysis (PCA) for AMR</a></dt>
+        <dd>
+        </dd><dt><a href="resistance_predict.html">How to predict antimicrobial resistance</a></dt>
+        <dd>
+        </dd><dt><a href="welcome_to_AMR.html">Welcome to the `AMR` package</a></dt>
+        <dd>
+        </dd><dt><a href="WHONET.html">How to work with WHONET data</a></dt>
+        <dd>
+      </dd></dl></div>
+  </main></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>
+

articles/other_pkg.html

@@ -0,0 +1,110 @@
+<!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>Using AMR with other packages: AMR &amp; dplyr/tidyverse • 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.4.2/css/all.min.css" rel="stylesheet">
+<link href="../deps/font-awesome-6.4.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="Using AMR with other packages: AMR &amp; dplyr/tidyverse">
+</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.9084</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="../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="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-article">
+
+
+
+
+<div class="row">
+  <main id="main" class="col-md-9"><div class="page-header">
+      <img src="../logo.svg" class="logo" alt=""><h1>Using AMR with other packages: AMR &amp; dplyr/tidyverse</h1>
+            
+      
+      <small class="dont-index">Source: <a href="https://github.com/msberends/AMR/blob/main/vignettes/other_pkg.Rmd" class="external-link"><code>vignettes/other_pkg.Rmd</code></a></small>
+      <div class="d-none name"><code>other_pkg.Rmd</code></div>
+    </div>
+
+    
+    
+<p>This page will be updated shortly, to give explicit examples of how
+to work ideally with the <code>AMR</code> package, for those who are
+used to working in <code>dplyr</code> or other tidyverse packages.</p>
+  </main>
+</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>

articles/resistance_predict.html

@@ -0,0 +1,277 @@
+<!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>How to predict antimicrobial resistance • 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.4.2/css/all.min.css" rel="stylesheet">
+<link href="../deps/font-awesome-6.4.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="How to predict antimicrobial resistance">
+</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.9084</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="active 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="../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="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-article">
+
+
+
+
+<div class="row">
+  <main id="main" class="col-md-9"><div class="page-header">
+      <img src="../logo.svg" class="logo" alt=""><h1>How to predict antimicrobial resistance</h1>
+            
+      
+      <small class="dont-index">Source: <a href="https://github.com/msberends/AMR/blob/main/vignettes/resistance_predict.Rmd" class="external-link"><code>vignettes/resistance_predict.Rmd</code></a></small>
+      <div class="d-none name"><code>resistance_predict.Rmd</code></div>
+    </div>
+
+    
+    
+<div class="section level2">
+<h2 id="needed-r-packages">Needed R packages<a class="anchor" aria-label="anchor" href="#needed-r-packages"></a>
+</h2>
+<p>As with many uses in R, we need some additional packages for AMR data
+analysis. Our package works closely together with the <a href="https://www.tidyverse.org" class="external-link">tidyverse packages</a> <a href="https://dplyr.tidyverse.org/" class="external-link"><code>dplyr</code></a> and <a href="https://ggplot2.tidyverse.org" class="external-link"><code>ggplot2</code></a>. The
+tidyverse tremendously improves the way we conduct data science - it
+allows for a very natural way of writing syntaxes and creating beautiful
+plots in R.</p>
+<p>Our <code>AMR</code> package depends on these packages and even
+extends their use and functions.</p>
+<div class="sourceCode" id="cb1"><pre class="downlit sourceCode r">
+<code class="sourceCode R"><span><span class="kw"><a href="https://rdrr.io/r/base/library.html" class="external-link">library</a></span><span class="op">(</span><span class="va"><a href="https://dplyr.tidyverse.org" class="external-link">dplyr</a></span><span class="op">)</span></span>
+<span><span class="kw"><a href="https://rdrr.io/r/base/library.html" class="external-link">library</a></span><span class="op">(</span><span class="va"><a href="https://ggplot2.tidyverse.org" class="external-link">ggplot2</a></span><span class="op">)</span></span>
+<span><span class="kw"><a href="https://rdrr.io/r/base/library.html" class="external-link">library</a></span><span class="op">(</span><span class="va"><a href="https://msberends.github.io/AMR/">AMR</a></span><span class="op">)</span></span>
+<span></span>
+<span><span class="co"># (if not yet installed, install with:)</span></span>
+<span><span class="co"># install.packages(c("tidyverse", "AMR"))</span></span></code></pre></div>
+</div>
+<div class="section level2">
+<h2 id="prediction-analysis">Prediction analysis<a class="anchor" aria-label="anchor" href="#prediction-analysis"></a>
+</h2>
+<p>Our package contains a function <code><a href="../reference/resistance_predict.html">resistance_predict()</a></code>,
+which takes the same input as functions for <a href="./AMR.html">other
+AMR data analysis</a>. Based on a date column, it calculates cases per
+year and uses a regression model to predict antimicrobial
+resistance.</p>
+<p>It is basically as easy as:</p>
+<div class="sourceCode" id="cb2"><pre class="downlit sourceCode r">
+<code class="sourceCode R"><span><span class="co"># resistance prediction of piperacillin/tazobactam (TZP):</span></span>
+<span><span class="fu"><a href="../reference/resistance_predict.html">resistance_predict</a></span><span class="op">(</span>tbl <span class="op">=</span> <span class="va">example_isolates</span>, col_date <span class="op">=</span> <span class="st">"date"</span>, col_ab <span class="op">=</span> <span class="st">"TZP"</span>, model <span class="op">=</span> <span class="st">"binomial"</span><span class="op">)</span></span>
+<span></span>
+<span><span class="co"># or:</span></span>
+<span><span class="va">example_isolates</span> <span class="op"><a href="https://magrittr.tidyverse.org/reference/pipe.html" class="external-link">%&gt;%</a></span></span>
+<span>  <span class="fu"><a href="../reference/resistance_predict.html">resistance_predict</a></span><span class="op">(</span></span>
+<span>    col_ab <span class="op">=</span> <span class="st">"TZP"</span>,</span>
+<span>    model <span class="op">=</span> <span class="st">"binomial"</span></span>
+<span>  <span class="op">)</span></span>
+<span></span>
+<span><span class="co"># to bind it to object 'predict_TZP' for example:</span></span>
+<span><span class="va">predict_TZP</span> <span class="op">&lt;-</span> <span class="va">example_isolates</span> <span class="op"><a href="https://magrittr.tidyverse.org/reference/pipe.html" class="external-link">%&gt;%</a></span></span>
+<span>  <span class="fu"><a href="../reference/resistance_predict.html">resistance_predict</a></span><span class="op">(</span></span>
+<span>    col_ab <span class="op">=</span> <span class="st">"TZP"</span>,</span>
+<span>    model <span class="op">=</span> <span class="st">"binomial"</span></span>
+<span>  <span class="op">)</span></span></code></pre></div>
+<p>The function will look for a date column itself if
+<code>col_date</code> is not set.</p>
+<p>When running any of these commands, a summary of the regression model
+will be printed unless using
+<code>resistance_predict(..., info = FALSE)</code>.</p>
+<p>This text is only a printed summary - the actual result (output) of
+the function is a <code>data.frame</code> containing for each year: the
+number of observations, the actual observed resistance, the estimated
+resistance and the standard error below and above the estimation:</p>
+<div class="sourceCode" id="cb3"><pre class="downlit sourceCode r">
+<code class="sourceCode R"><span><span class="va">predict_TZP</span></span>
+<span><span class="co">#&gt; <span style="color: #949494;"># A tibble: 33 × 7</span></span></span>
+<span><span class="co">#&gt;     year  value se_min se_max observations observed estimated</span></span>
+<span><span class="co">#&gt;  <span style="color: #BCBCBC;">*</span> <span style="color: #949494; font-style: italic;">&lt;dbl&gt;</span>  <span style="color: #949494; font-style: italic;">&lt;dbl&gt;</span>  <span style="color: #949494; font-style: italic;">&lt;dbl&gt;</span>  <span style="color: #949494; font-style: italic;">&lt;dbl&gt;</span>        <span style="color: #949494; font-style: italic;">&lt;int&gt;</span>    <span style="color: #949494; font-style: italic;">&lt;dbl&gt;</span>     <span style="color: #949494; font-style: italic;">&lt;dbl&gt;</span></span></span>
+<span><span class="co">#&gt; <span style="color: #BCBCBC;"> 1</span>  <span style="text-decoration: underline;">2</span>002 0.2        <span style="color: #BB0000;">NA</span>     <span style="color: #BB0000;">NA</span>           15   0.2       0.056<span style="text-decoration: underline;">2</span></span></span>
+<span><span class="co">#&gt; <span style="color: #BCBCBC;"> 2</span>  <span style="text-decoration: underline;">2</span>003 0.062<span style="text-decoration: underline;">5</span>     <span style="color: #BB0000;">NA</span>     <span style="color: #BB0000;">NA</span>           32   0.062<span style="text-decoration: underline;">5</span>    0.061<span style="text-decoration: underline;">6</span></span></span>
+<span><span class="co">#&gt; <span style="color: #BCBCBC;"> 3</span>  <span style="text-decoration: underline;">2</span>004 0.085<span style="text-decoration: underline;">4</span>     <span style="color: #BB0000;">NA</span>     <span style="color: #BB0000;">NA</span>           82   0.085<span style="text-decoration: underline;">4</span>    0.067<span style="text-decoration: underline;">6</span></span></span>
+<span><span class="co">#&gt; <span style="color: #BCBCBC;"> 4</span>  <span style="text-decoration: underline;">2</span>005 0.05       <span style="color: #BB0000;">NA</span>     <span style="color: #BB0000;">NA</span>           60   0.05      0.074<span style="text-decoration: underline;">1</span></span></span>
+<span><span class="co">#&gt; <span style="color: #BCBCBC;"> 5</span>  <span style="text-decoration: underline;">2</span>006 0.050<span style="text-decoration: underline;">8</span>     <span style="color: #BB0000;">NA</span>     <span style="color: #BB0000;">NA</span>           59   0.050<span style="text-decoration: underline;">8</span>    0.081<span style="text-decoration: underline;">2</span></span></span>
+<span><span class="co">#&gt; <span style="color: #BCBCBC;"> 6</span>  <span style="text-decoration: underline;">2</span>007 0.121      <span style="color: #BB0000;">NA</span>     <span style="color: #BB0000;">NA</span>           66   0.121     0.088<span style="text-decoration: underline;">9</span></span></span>
+<span><span class="co">#&gt; <span style="color: #BCBCBC;"> 7</span>  <span style="text-decoration: underline;">2</span>008 0.041<span style="text-decoration: underline;">7</span>     <span style="color: #BB0000;">NA</span>     <span style="color: #BB0000;">NA</span>           72   0.041<span style="text-decoration: underline;">7</span>    0.097<span style="text-decoration: underline;">2</span></span></span>
+<span><span class="co">#&gt; <span style="color: #BCBCBC;"> 8</span>  <span style="text-decoration: underline;">2</span>009 0.016<span style="text-decoration: underline;">4</span>     <span style="color: #BB0000;">NA</span>     <span style="color: #BB0000;">NA</span>           61   0.016<span style="text-decoration: underline;">4</span>    0.106 </span></span>
+<span><span class="co">#&gt; <span style="color: #BCBCBC;"> 9</span>  <span style="text-decoration: underline;">2</span>010 0.056<span style="text-decoration: underline;">6</span>     <span style="color: #BB0000;">NA</span>     <span style="color: #BB0000;">NA</span>           53   0.056<span style="text-decoration: underline;">6</span>    0.116 </span></span>
+<span><span class="co">#&gt; <span style="color: #BCBCBC;">10</span>  <span style="text-decoration: underline;">2</span>011 0.183      <span style="color: #BB0000;">NA</span>     <span style="color: #BB0000;">NA</span>           93   0.183     0.127 </span></span>
+<span><span class="co">#&gt; <span style="color: #949494;"># ℹ 23 more rows</span></span></span></code></pre></div>
+<p>The function <code>plot</code> is available in base R, and can be
+extended by other packages to depend the output based on the type of
+input. We extended its function to cope with resistance predictions:</p>
+<div class="sourceCode" id="cb4"><pre class="downlit sourceCode r">
+<code class="sourceCode R"><span><span class="fu"><a href="../reference/plot.html">plot</a></span><span class="op">(</span><span class="va">predict_TZP</span><span class="op">)</span></span></code></pre></div>
+<p><img src="resistance_predict_files/figure-html/unnamed-chunk-4-1.png" width="720"></p>
+<p>This is the fastest way to plot the result. It automatically adds the
+right axes, error bars, titles, number of available observations and
+type of model.</p>
+<p>We also support the <code>ggplot2</code> package with our custom
+function <code><a href="../reference/resistance_predict.html">ggplot_sir_predict()</a></code> to create more appealing
+plots:</p>
+<div class="sourceCode" id="cb5"><pre class="downlit sourceCode r">
+<code class="sourceCode R"><span><span class="fu"><a href="../reference/resistance_predict.html">ggplot_sir_predict</a></span><span class="op">(</span><span class="va">predict_TZP</span><span class="op">)</span></span></code></pre></div>
+<p><img src="resistance_predict_files/figure-html/unnamed-chunk-5-1.png" width="720"></p>
+<div class="sourceCode" id="cb6"><pre class="downlit sourceCode r">
+<code class="sourceCode R"><span></span>
+<span><span class="co"># choose for error bars instead of a ribbon</span></span>
+<span><span class="fu"><a href="../reference/resistance_predict.html">ggplot_sir_predict</a></span><span class="op">(</span><span class="va">predict_TZP</span>, ribbon <span class="op">=</span> <span class="cn">FALSE</span><span class="op">)</span></span></code></pre></div>
+<p><img src="resistance_predict_files/figure-html/unnamed-chunk-5-2.png" width="720"></p>
+<div class="section level3">
+<h3 id="choosing-the-right-model">Choosing the right model<a class="anchor" aria-label="anchor" href="#choosing-the-right-model"></a>
+</h3>
+<p>Resistance is not easily predicted; if we look at vancomycin
+resistance in Gram-positive bacteria, the spread (i.e. standard error)
+is enormous:</p>
+<div class="sourceCode" id="cb7"><pre class="downlit sourceCode r">
+<code class="sourceCode R"><span><span class="va">example_isolates</span> <span class="op"><a href="https://magrittr.tidyverse.org/reference/pipe.html" class="external-link">%&gt;%</a></span></span>
+<span>  <span class="fu"><a href="https://dplyr.tidyverse.org/reference/filter.html" class="external-link">filter</a></span><span class="op">(</span><span class="fu"><a href="../reference/mo_property.html">mo_gramstain</a></span><span class="op">(</span><span class="va">mo</span>, language <span class="op">=</span> <span class="cn">NULL</span><span class="op">)</span> <span class="op">==</span> <span class="st">"Gram-positive"</span><span class="op">)</span> <span class="op"><a href="https://magrittr.tidyverse.org/reference/pipe.html" class="external-link">%&gt;%</a></span></span>
+<span>  <span class="fu"><a href="../reference/resistance_predict.html">resistance_predict</a></span><span class="op">(</span>col_ab <span class="op">=</span> <span class="st">"VAN"</span>, year_min <span class="op">=</span> <span class="fl">2010</span>, info <span class="op">=</span> <span class="cn">FALSE</span>, model <span class="op">=</span> <span class="st">"binomial"</span><span class="op">)</span> <span class="op"><a href="https://magrittr.tidyverse.org/reference/pipe.html" class="external-link">%&gt;%</a></span></span>
+<span>  <span class="fu"><a href="../reference/resistance_predict.html">ggplot_sir_predict</a></span><span class="op">(</span><span class="op">)</span></span></code></pre></div>
+<p><img src="resistance_predict_files/figure-html/unnamed-chunk-6-1.png" width="720"></p>
+<p>Vancomycin resistance could be 100% in ten years, but might remain
+very low.</p>
+<p>You can define the model with the <code>model</code> parameter. The
+model chosen above is a generalised linear regression model using a
+binomial distribution, assuming that a period of zero resistance was
+followed by a period of increasing resistance leading slowly to more and
+more resistance.</p>
+<p>Valid values are:</p>
+<table class="table">
+<colgroup>
+<col width="32%">
+<col width="25%">
+<col width="42%">
+</colgroup>
+<thead><tr class="header">
+<th>Input values</th>
+<th>Function used by R</th>
+<th>Type of model</th>
+</tr></thead>
+<tbody>
+<tr class="odd">
+<td>
+<code>"binomial"</code> or <code>"binom"</code> or
+<code>"logit"</code>
+</td>
+<td><code>glm(..., family = binomial)</code></td>
+<td>Generalised linear model with binomial distribution</td>
+</tr>
+<tr class="even">
+<td>
+<code>"loglin"</code> or <code>"poisson"</code>
+</td>
+<td><code>glm(..., family = poisson)</code></td>
+<td>Generalised linear model with poisson distribution</td>
+</tr>
+<tr class="odd">
+<td>
+<code>"lin"</code> or <code>"linear"</code>
+</td>
+<td><code><a href="https://rdrr.io/r/stats/lm.html" class="external-link">lm()</a></code></td>
+<td>Linear model</td>
+</tr>
+</tbody>
+</table>
+<p>For the vancomycin resistance in Gram-positive bacteria, a linear
+model might be more appropriate:</p>
+<div class="sourceCode" id="cb8"><pre class="downlit sourceCode r">
+<code class="sourceCode R"><span><span class="va">example_isolates</span> <span class="op"><a href="https://magrittr.tidyverse.org/reference/pipe.html" class="external-link">%&gt;%</a></span></span>
+<span>  <span class="fu"><a href="https://dplyr.tidyverse.org/reference/filter.html" class="external-link">filter</a></span><span class="op">(</span><span class="fu"><a href="../reference/mo_property.html">mo_gramstain</a></span><span class="op">(</span><span class="va">mo</span>, language <span class="op">=</span> <span class="cn">NULL</span><span class="op">)</span> <span class="op">==</span> <span class="st">"Gram-positive"</span><span class="op">)</span> <span class="op"><a href="https://magrittr.tidyverse.org/reference/pipe.html" class="external-link">%&gt;%</a></span></span>
+<span>  <span class="fu"><a href="../reference/resistance_predict.html">resistance_predict</a></span><span class="op">(</span>col_ab <span class="op">=</span> <span class="st">"VAN"</span>, year_min <span class="op">=</span> <span class="fl">2010</span>, info <span class="op">=</span> <span class="cn">FALSE</span>, model <span class="op">=</span> <span class="st">"linear"</span><span class="op">)</span> <span class="op"><a href="https://magrittr.tidyverse.org/reference/pipe.html" class="external-link">%&gt;%</a></span></span>
+<span>  <span class="fu"><a href="../reference/resistance_predict.html">ggplot_sir_predict</a></span><span class="op">(</span><span class="op">)</span></span></code></pre></div>
+<p><img src="resistance_predict_files/figure-html/unnamed-chunk-7-1.png" width="720"></p>
+<p>The model itself is also available from the object, as an
+<code>attribute</code>:</p>
+<div class="sourceCode" id="cb9"><pre class="downlit sourceCode r">
+<code class="sourceCode R"><span><span class="va">model</span> <span class="op">&lt;-</span> <span class="fu"><a href="https://rdrr.io/r/base/attributes.html" class="external-link">attributes</a></span><span class="op">(</span><span class="va">predict_TZP</span><span class="op">)</span><span class="op">$</span><span class="va">model</span></span>
+<span></span>
+<span><span class="fu"><a href="https://rdrr.io/r/base/summary.html" class="external-link">summary</a></span><span class="op">(</span><span class="va">model</span><span class="op">)</span><span class="op">$</span><span class="va">family</span></span>
+<span><span class="co">#&gt; </span></span>
+<span><span class="co">#&gt; Family: binomial </span></span>
+<span><span class="co">#&gt; Link function: logit</span></span>
+<span></span>
+<span><span class="fu"><a href="https://rdrr.io/r/base/summary.html" class="external-link">summary</a></span><span class="op">(</span><span class="va">model</span><span class="op">)</span><span class="op">$</span><span class="va">coefficients</span></span>
+<span><span class="co">#&gt;                  Estimate  Std. Error   z value     Pr(&gt;|z|)</span></span>
+<span><span class="co">#&gt; (Intercept) -200.67944891 46.17315349 -4.346237 1.384932e-05</span></span>
+<span><span class="co">#&gt; year           0.09883005  0.02295317  4.305725 1.664395e-05</span></span></code></pre></div>
+</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>

articles/welcome_to_AMR.html

@@ -0,0 +1,203 @@
+<!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>Welcome to the `AMR` package • 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.4.2/css/all.min.css" rel="stylesheet">
+<link href="../deps/font-awesome-6.4.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="Welcome to the `AMR` package">
+</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.9084</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="../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="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-article">
+
+
+
+
+<div class="row">
+  <main id="main" class="col-md-9"><div class="page-header">
+      <img src="../logo.svg" class="logo" alt=""><h1>Welcome to the `AMR` package</h1>
+            
+      
+      <small class="dont-index">Source: <a href="https://github.com/msberends/AMR/blob/main/vignettes/welcome_to_AMR.Rmd" class="external-link"><code>vignettes/welcome_to_AMR.Rmd</code></a></small>
+      <div class="d-none name"><code>welcome_to_AMR.Rmd</code></div>
+    </div>
+
+    
+    
+<p>Note: to keep the package size as small as possible, we only include
+this vignette on CRAN. You can read more vignettes on our website about
+how to conduct AMR data analysis, determine MDROs, find explanation of
+EUCAST and CLSI breakpoints, and much more: <a href="https://msberends.github.io/AMR/articles/" class="uri">https://msberends.github.io/AMR/articles/</a>.</p>
+<hr>
+<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 ~79 000 distinct microbial
+species 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
+breakpoint guidelines from CLSI and EUCAST are included from the last 10
+years. It supports and can read any data format, including WHONET
+data.</p>
+<p>With the help of contributors from all corners of the world, the
+<code>AMR</code> package is available in English, Czech, Chinese,
+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>
+<p>This package is fully independent of any other R package and 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>. Since its first public release in
+early 2018, this package has been downloaded from more than 175
+countries.</p>
+<p>This package can be used for:</p>
+<ul>
+<li>Reference for the taxonomy of microorganisms, since the package
+contains all microbial (sub)species from the List of Prokaryotic names
+with Standing in Nomenclature (LPSN) and the Global Biodiversity
+Information Facility (GBIF)</li>
+<li>Interpreting raw MIC and disk diffusion values, based on the latest
+CLSI or EUCAST guidelines</li>
+<li>Retrieving antimicrobial drug names, doses and forms of
+administration from clinical health care records</li>
+<li>Determining first isolates to be used for AMR data analysis</li>
+<li>Calculating antimicrobial resistance</li>
+<li>Determining multi-drug resistance (MDR) / multi-drug resistant
+organisms (MDRO)</li>
+<li>Calculating (empirical) susceptibility of both mono therapy and
+combination therapies</li>
+<li>Predicting future antimicrobial resistance using regression
+models</li>
+<li>Getting properties for any microorganism (like Gram stain, species,
+genus or family)</li>
+<li>Getting properties for any antibiotic (like name, code of
+EARS-Net/ATC/LOINC/PubChem, defined daily dose or trade name)</li>
+<li>Plotting antimicrobial resistance</li>
+<li>Applying EUCAST expert rules</li>
+<li>Getting SNOMED codes of a microorganism, or getting properties of a
+microorganism based on a SNOMED code</li>
+<li>Getting LOINC codes of an antibiotic, or getting properties of an
+antibiotic based on a LOINC code</li>
+<li>Machine reading the EUCAST and CLSI guidelines from 2011-2020 to
+translate MIC values and disk diffusion diameters to SIR</li>
+<li>Principal component analysis for AMR</li>
+</ul>
+<p>All reference data sets (about microorganisms, antibiotics, SIR
+interpretation, EUCAST rules, etc.) in this <code>AMR</code> package are
+publicly and freely available. We continually export our data sets to
+formats for use in R, SPSS, Stata and Excel. We also supply flat files
+that are machine-readable and suitable for input in any software
+program, such as laboratory information systems. Please find <a href="https://msberends.github.io/AMR/articles/datasets.html">all
+download links on our website</a>, which is automatically updated with
+every code change.</p>
+<p>This R package was created for both routine data analysis and
+academic research at the Faculty of Medical Sciences of the <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>, and
+is being <a href="https://msberends.github.io/AMR/news/">actively and
+durably maintained</a> by two public healthcare organisations in the
+Netherlands.</p>
+<hr>
+<p><small> This AMR package for R is free, open-source software and
+licensed under the <a href="https://msberends.github.io/AMR/LICENSE-text.html">GNU General
+Public License v2.0 (GPL-2)</a>. These requirements are consequently
+legally binding: modifications must be released under the same license
+when distributing the package, changes made to the code must be
+documented, source code must be made available when the package is
+distributed, and a copy of the license and copyright notice must be
+included with the package. </small></p>
+  </main>
+</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>

authors.html

@@ -0,0 +1,197 @@
+<!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>Authors and Citation • 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.4.2/css/all.min.css" rel="stylesheet"><link href="deps/font-awesome-6.4.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="Authors and Citation"><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.9084</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="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="active 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-citation-authors">
+<div class="row">
+  <main id="main" class="col-md-9"><div class="page-header">
+      <img src="logo.svg" class="logo" alt=""><h1>Authors and Citation</h1>
+    </div>
+
+    <div class="section level2">
+      <h2>Authors</h2>
+
+      <ul class="list-unstyled"><li>
+          <p><strong>Matthijs S. Berends</strong>. Author, maintainer. <a href="https://orcid.org/0000-0001-7620-1800" target="orcid.widget" aria-label="ORCID" class="external-link"><span class="fab fa-orcid orcid" aria-hidden="true"></span></a>
+          </p>
+        </li>
+        <li>
+          <p><strong>Dennis Souverein</strong>. Author, contributor. <a href="https://orcid.org/0000-0003-0455-0336" target="orcid.widget" aria-label="ORCID" class="external-link"><span class="fab fa-orcid orcid" aria-hidden="true"></span></a>
+          </p>
+        </li>
+        <li>
+          <p><strong>Erwin E. A. Hassing</strong>. Author, contributor.
+          </p>
+        </li>
+        <li>
+          <p><strong>Casper J. Albers</strong>. Thesis advisor. <a href="https://orcid.org/0000-0002-9213-6743" target="orcid.widget" aria-label="ORCID" class="external-link"><span class="fab fa-orcid orcid" aria-hidden="true"></span></a>
+          </p>
+        </li>
+        <li>
+          <p><strong>Larisse Bolton</strong>. Contributor. <a href="https://orcid.org/0000-0001-7879-2173" target="orcid.widget" aria-label="ORCID" class="external-link"><span class="fab fa-orcid orcid" aria-hidden="true"></span></a>
+          </p>
+        </li>
+        <li>
+          <p><strong>Peter Dutey-Magni</strong>. Contributor. <a href="https://orcid.org/0000-0002-8942-9836" target="orcid.widget" aria-label="ORCID" class="external-link"><span class="fab fa-orcid orcid" aria-hidden="true"></span></a>
+          </p>
+        </li>
+        <li>
+          <p><strong>Judith M. Fonville</strong>. Contributor.
+          </p>
+        </li>
+        <li>
+          <p><strong>Alex W. Friedrich</strong>. Thesis advisor. <a href="https://orcid.org/0000-0003-4881-038X" target="orcid.widget" aria-label="ORCID" class="external-link"><span class="fab fa-orcid orcid" aria-hidden="true"></span></a>
+          </p>
+        </li>
+        <li>
+          <p><strong>Corinna Glasner</strong>. Thesis advisor. <a href="https://orcid.org/0000-0003-1241-1328" target="orcid.widget" aria-label="ORCID" class="external-link"><span class="fab fa-orcid orcid" aria-hidden="true"></span></a>
+          </p>
+        </li>
+        <li>
+          <p><strong>Eric H. L. C. M. Hazenberg</strong>. Contributor.
+          </p>
+        </li>
+        <li>
+          <p><strong>Gwen Knight</strong>. Contributor. <a href="https://orcid.org/0000-0002-7263-9896" target="orcid.widget" aria-label="ORCID" class="external-link"><span class="fab fa-orcid orcid" aria-hidden="true"></span></a>
+          </p>
+        </li>
+        <li>
+          <p><strong>Annick Lenglet</strong>. Contributor. <a href="https://orcid.org/0000-0003-2013-8405" target="orcid.widget" aria-label="ORCID" class="external-link"><span class="fab fa-orcid orcid" aria-hidden="true"></span></a>
+          </p>
+        </li>
+        <li>
+          <p><strong>Christian F. Luz</strong>. Contributor. <a href="https://orcid.org/0000-0001-5809-5995" target="orcid.widget" aria-label="ORCID" class="external-link"><span class="fab fa-orcid orcid" aria-hidden="true"></span></a>
+          </p>
+        </li>
+        <li>
+          <p><strong>Bart C. Meijer</strong>. Contributor.
+          </p>
+        </li>
+        <li>
+          <p><strong>Dmytro Mykhailenko</strong>. Contributor.
+          </p>
+        </li>
+        <li>
+          <p><strong>Anton Mymrikov</strong>. Contributor.
+          </p>
+        </li>
+        <li>
+          <p><strong>Andrew P. Norgan</strong>. Contributor. <a href="https://orcid.org/0000-0002-2955-2066" target="orcid.widget" aria-label="ORCID" class="external-link"><span class="fab fa-orcid orcid" aria-hidden="true"></span></a>
+          </p>
+        </li>
+        <li>
+          <p><strong>Sofia Ny</strong>. Contributor. <a href="https://orcid.org/0000-0002-2017-1363" target="orcid.widget" aria-label="ORCID" class="external-link"><span class="fab fa-orcid orcid" aria-hidden="true"></span></a>
+          </p>
+        </li>
+        <li>
+          <p><strong>Matthew Saab</strong>. Contributor.
+          </p>
+        </li>
+        <li>
+          <p><strong>Jonas Salm</strong>. Contributor.
+          </p>
+        </li>
+        <li>
+          <p><strong>Javier Sanchez</strong>. Contributor. <a href="https://orcid.org/0000-0003-2605-8094" target="orcid.widget" aria-label="ORCID" class="external-link"><span class="fab fa-orcid orcid" aria-hidden="true"></span></a>
+          </p>
+        </li>
+        <li>
+          <p><strong>Rogier P. Schade</strong>. Contributor.
+          </p>
+        </li>
+        <li>
+          <p><strong>Bhanu N. M. Sinha</strong>. Thesis advisor. <a href="https://orcid.org/0000-0003-1634-0010" target="orcid.widget" aria-label="ORCID" class="external-link"><span class="fab fa-orcid orcid" aria-hidden="true"></span></a>
+          </p>
+        </li>
+        <li>
+          <p><strong>Jason Stull</strong>. Contributor. <a href="https://orcid.org/0000-0002-9028-8153" target="orcid.widget" aria-label="ORCID" class="external-link"><span class="fab fa-orcid orcid" aria-hidden="true"></span></a>
+          </p>
+        </li>
+        <li>
+          <p><strong>Anthony Underwood</strong>. Contributor. <a href="https://orcid.org/0000-0002-8547-4277" target="orcid.widget" aria-label="ORCID" class="external-link"><span class="fab fa-orcid orcid" aria-hidden="true"></span></a>
+          </p>
+        </li>
+        <li>
+          <p><strong>Anita Williams</strong>. Contributor. <a href="https://orcid.org/0000-0002-5295-8451" target="orcid.widget" aria-label="ORCID" class="external-link"><span class="fab fa-orcid orcid" aria-hidden="true"></span></a>
+          </p>
+        </li>
+      </ul></div>
+
+    <div class="section level2">
+      <h2 id="citation">Citation</h2>
+      <p><small class="dont-index">Source: <a href="https://github.com/msberends/AMR/blob/main/inst/CITATION" class="external-link"><code>inst/CITATION</code></a></small></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>, <b>104</b>(3), 1–31.
+<a href="https://doi.org/10.18637/jss.v104.i03" class="external-link">doi:10.18637/jss.v104.i03</a>.
+</p>
+      <pre>@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},
+}</pre>
+    </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>
+

browserconfig.xml

@@ -0,0 +1,10 @@
+<?xml version="1.0" encoding="utf-8"?>
+<browserconfig>
+    <msapplication>
+        <tile>
+            <square150x150logo src="/mstile-150x150.png?v=newlogo"/>
+            <square310x310logo src="/mstile-310x310.png?v=newlogo"/>
+            <TileColor>#128f76</TileColor>
+        </tile>
+    </msapplication>
+</browserconfig>

codecov.yml

@@ -1,22 +0,0 @@
-codecov:
-  notify:
-    require_ci_to_pass: no # allow fail
-  ci:
-    - !appveyor # ignore CI builds by AppVeyor
-
-comment: no
-
-coverage:
-  precision: 1
-  round: up
-  range: "0...100"
-  status:
-    project: no
-    patch: no
-    changes: no
-
-ignore:
-  - "R/atc_online.R"
-  - "R/mo_history.R"
-  - "R/mo_source.R"
-  - "R/resistance_predict.R" # gives a strange error but unit tests work

cran-comments.md

@@ -1,7 +0,0 @@
-# Version 0.9.0
-
-* For this specific version, nothing to mention.
-
-* Since version 0.3.0, CHECK returns a NOTE for having a data directory over 3 MB. This is needed to offer users reference data for the complete taxonomy of microorganisms - one of the most important features of this package.
-
-* Since version 0.8.0, this package writes lines to `[library path]/AMR/mo_history/mo_history.csv` when using the `as.mo()` function, in the exact same way (and borrowed from) the `extrafont` package on CRAN (version 0.17) writes to the user library path. Users are notified about this with a `message()`, and staged install on R >= 3.6.0 still works. The CSV file is never newly created or deleted by this package, it only changes this file to improve speed and reliability of the `as.mo()` function. See the source code of functions `set_mo_history()` and `clear_mo_history()` in file `R/mo_history.R`.

data-raw/eucast_rules.tsv

@@ -1,198 +0,0 @@
-# -------------------------------------------------------------------------------------------------------------------------------
-# For editing this EUCAST reference file, these values can all be used for target antibiotics:
-# 'all_betalactams', 'aminoglycosides', 'aminopenicillins', 'carbapenems', 'cephalosporins', 'cephalosporins_except_CAZ',
-# 'fluoroquinolones', 'glycopeptides', 'macrolides', 'polymyxins', 'streptogramins', 'tetracyclines', 'ureidopenicillins'
-# and all separate EARS-Net letter codes like 'AMC'. They can be separated by comma: 'AMC, fluoroquinolones'.
-# The 'if_mo_property' column can be any column name from the AMR::microorganisms data set, or "genus_species" or "gramstain".
-# The like.is.one_of column must be 'like' or 'is' or 'one_of' ('like' will read the 'this_value' column as regular expression)
-# The EUCAST guideline contains references to the 'Burkholderia cepacia complex'. All species in this group can be found in: LiPuma J (2005, PMID 16217180).
-# >>>>> IF YOU WANT TO IMPORT THIS FILE INTO YOUR OWN SOFTWARE, HAVE THE FIRST 10 LINES SKIPPED <<<<<
-# -------------------------------------------------------------------------------------------------------------------------------
-if_mo_property	like.is.one_of	this_value	and_these_antibiotics	have_these_values	then_change_these_antibiotics	to_value	reference.rule	reference.rule_group
-genus	like	.*	AMP	S	AMX	S	Non-EUCAST: inherit ampicillin results for unavailable amoxicillin	Other rules
-genus	like	.*	AMP	I	AMX	I	Non-EUCAST: inherit ampicillin results for unavailable amoxicillin	Other rules
-genus	like	.*	AMP	R	AMX	R	Non-EUCAST: inherit ampicillin results for unavailable amoxicillin	Other rules
-genus	like	.*	AMX	S	AMP	S	Non-EUCAST: inherit amoxicillin results for unavailable ampicillin	Other rules
-genus	like	.*	AMX	I	AMP	I	Non-EUCAST: inherit amoxicillin results for unavailable ampicillin	Other rules
-genus	like	.*	AMX	R	AMP	R	Non-EUCAST: inherit amoxicillin results for unavailable ampicillin	Other rules
-genus	like	.*	AMC	R	AMP, AMX	R	Non-EUCAST: set ampicillin = R where amoxicillin/clav acid = R	Other rules
-genus	like	.*	TZP	R	PIP	R	Non-EUCAST: set piperacillin = R where piperacillin/tazobactam = R	Other rules
-genus	like	.*	SXT	R	TMP	R	Non-EUCAST: set trimethoprim = R where trimethoprim/sulfa = R	Other rules
-genus	like	.*	AMP	S	AMC	S	Non-EUCAST: set amoxicillin/clav acid = S where ampicillin = S	Other rules
-genus	like	.*	AMX	S	AMC	S	Non-EUCAST: set amoxicillin/clav acid = S where ampicillin = S	Other rules
-genus	like	.*	PIP	S	TZP	S	Non-EUCAST: set piperacillin/tazobactam = S where piperacillin = S	Other rules
-genus	like	.*	TMP	S	SXT	S	Non-EUCAST: set trimethoprim/sulfa = S where trimethoprim = S	Other rules
-order	is	Enterobacterales	AMP	S	AMX	S	Enterobacterales (Order)	Breakpoints
-order	is	Enterobacterales	AMP	I	AMX	I	Enterobacterales (Order)	Breakpoints
-order	is	Enterobacterales	AMP	R	AMX	R	Enterobacterales (Order)	Breakpoints
-genus	is	Staphylococcus	PEN, FOX	S	AMP, AMX, PIP, TIC	S	Staphylococcus	Breakpoints
-genus	is	Staphylococcus	PEN, FOX	R, S	OXA, FLC	S	Staphylococcus	Breakpoints
-genus	is	Staphylococcus	FOX	R	all_betalactams	R	Staphylococcus	Breakpoints
-genus_species	is	Staphylococcus saprophyticus	AMP	S	AMX, AMC, PIP, TZP	S	Staphylococcus	Breakpoints
-genus	is	Staphylococcus	FOX	S	carbapenems, cephalosporins_except_CAZ	S	Staphylococcus	Breakpoints
-genus	is	Staphylococcus	FOX	I	carbapenems, cephalosporins_except_CAZ	I	Staphylococcus	Breakpoints
-genus	is	Staphylococcus	FOX	R	carbapenems, cephalosporins_except_CAZ	R	Staphylococcus	Breakpoints
-genus	is	Staphylococcus	NOR	S	CIP, LVX, MFX, OFX	S	Staphylococcus	Breakpoints
-genus	is	Staphylococcus	ERY	S	AZM, CLR, RXT	S	Staphylococcus	Breakpoints
-genus	is	Staphylococcus	ERY	I	AZM, CLR, RXT	I	Staphylococcus	Breakpoints
-genus	is	Staphylococcus	ERY	R	AZM, CLR, RXT	R	Staphylococcus	Breakpoints
-genus	is	Staphylococcus	TCY	S	DOX, MNO	S	Staphylococcus	Breakpoints
-genus_species	is	Enterococcus faecium	AMP	R	all_betalactams	R	Enterococcus	Breakpoints
-genus	is	Enterococcus	AMP	S	AMX, AMC, PIP, TZP	S	Enterococcus	Breakpoints
-genus	is	Enterococcus	AMP	I	AMX, AMC, PIP, TZP	I	Enterococcus	Breakpoints
-genus	is	Enterococcus	AMP	R	AMX, AMC, PIP, TZP	R	Enterococcus	Breakpoints
-genus	is	Enterococcus	NOR	S	CIP, LVX	S	Enterococcus	Breakpoints
-genus	is	Enterococcus	NOR	I	CIP, LVX	I	Enterococcus	Breakpoints
-genus	is	Enterococcus	NOR	R	CIP, LVX	R	Enterococcus	Breakpoints
-genus_species	like	^Streptococcus (pyogenes|agalactiae|dysgalactiae|group A|group B|group C|group G)$	PEN	S	aminopenicillins, ureidopenicillins, cephalosporins_except_CAZ, carbapenems, FLC, AMC	S	Streptococcus groups A, B, C, G	Breakpoints
-genus_species	like	^Streptococcus (pyogenes|agalactiae|dysgalactiae|group A|group B|group C|group G)$	PEN	I	aminopenicillins, ureidopenicillins, cephalosporins_except_CAZ, carbapenems, FLC, AMC	I	Streptococcus groups A, B, C, G	Breakpoints
-genus_species	like	^Streptococcus (pyogenes|agalactiae|dysgalactiae|group A|group B|group C|group G)$	PEN	R	aminopenicillins, ureidopenicillins, cephalosporins_except_CAZ, carbapenems, FLC, AMC	R	Streptococcus groups A, B, C, G	Breakpoints
-genus_species	like	^Streptococcus (pyogenes|agalactiae|dysgalactiae|group A|group B|group C|group G)$	NOR	S	LVX, MFX	S	Streptococcus groups A, B, C, G	Breakpoints
-genus_species	like	^Streptococcus (pyogenes|agalactiae|dysgalactiae|group A|group B|group C|group G)$	ERY	S	AZM, CLR, RXT	S	Streptococcus groups A, B, C, G	Breakpoints
-genus_species	like	^Streptococcus (pyogenes|agalactiae|dysgalactiae|group A|group B|group C|group G)$	ERY	I	AZM, CLR, RXT	I	Streptococcus groups A, B, C, G	Breakpoints
-genus_species	like	^Streptococcus (pyogenes|agalactiae|dysgalactiae|group A|group B|group C|group G)$	ERY	R	AZM, CLR, RXT	R	Streptococcus groups A, B, C, G	Breakpoints
-genus_species	like	^Streptococcus (pyogenes|agalactiae|dysgalactiae|group A|group B|group C|group G)$	TCY	S	DOX, MNO	S	Streptococcus groups A, B, C, G	Breakpoints
-genus_species	is	Streptococcus pneumoniae	PEN	S	AMP, AMX, AMC, PIP, TZP	S	Streptococcus pneumoniae	Breakpoints
-genus_species	is	Streptococcus pneumoniae	AMP	S	AMX, AMC, PIP, TZP	S	Streptococcus pneumoniae	Breakpoints
-genus_species	is	Streptococcus pneumoniae	AMP	I	AMX, AMC, PIP, TZP	I	Streptococcus pneumoniae	Breakpoints
-genus_species	is	Streptococcus pneumoniae	AMP	R	AMX, AMC, PIP, TZP	R	Streptococcus pneumoniae	Breakpoints
-genus_species	is	Streptococcus pneumoniae	NOR	S	LVX, MFX	S	Streptococcus pneumoniae	Breakpoints
-genus_species	is	Streptococcus pneumoniae	ERY	S	AZM, CLR, RXT	S	Streptococcus pneumoniae	Breakpoints
-genus_species	is	Streptococcus pneumoniae	ERY	I	AZM, CLR, RXT	I	Streptococcus pneumoniae	Breakpoints
-genus_species	is	Streptococcus pneumoniae	ERY	R	AZM, CLR, RXT	R	Streptococcus pneumoniae	Breakpoints
-genus_species	is	Streptococcus pneumoniae	TCY	S	DOX, MNO	S	Streptococcus pneumoniae	Breakpoints
-genus_species	like	^Streptococcus (australis|bovis|constellatus|cristatus|gallolyticus|gordonii|infantarius|infantis|mitis|mutans|oligofermentans|oralis|peroris|pseudopneumoniae|salivarius|sinensis|sobrinus|thermophilus|vestibularis|anginosus|equinus|intermedius|parasanguinis|sanguinis)$	PEN	S	AMP, AMX, AMC, PIP, TZP	S	Viridans group streptococci	Breakpoints
-genus_species	like	^Streptococcus (australis|bovis|constellatus|cristatus|gallolyticus|gordonii|infantarius|infantis|mitis|mutans|oligofermentans|oralis|peroris|pseudopneumoniae|salivarius|sinensis|sobrinus|thermophilus|vestibularis|anginosus|equinus|intermedius|parasanguinis|sanguinis)$	AMP	S	AMX, AMC, PIP, TZP	S	Viridans group streptococci	Breakpoints
-genus_species	like	^Streptococcus (australis|bovis|constellatus|cristatus|gallolyticus|gordonii|infantarius|infantis|mitis|mutans|oligofermentans|oralis|peroris|pseudopneumoniae|salivarius|sinensis|sobrinus|thermophilus|vestibularis|anginosus|equinus|intermedius|parasanguinis|sanguinis)$	AMP	I	AMX, AMC, PIP, TZP	I	Viridans group streptococci	Breakpoints
-genus_species	like	^Streptococcus (australis|bovis|constellatus|cristatus|gallolyticus|gordonii|infantarius|infantis|mitis|mutans|oligofermentans|oralis|peroris|pseudopneumoniae|salivarius|sinensis|sobrinus|thermophilus|vestibularis|anginosus|equinus|intermedius|parasanguinis|sanguinis)$	AMP	R	AMX, AMC, PIP, TZP	R	Viridans group streptococci	Breakpoints
-genus_species	is	Haemophilus influenzae	AMP	S	AMX, PIP	S	Haemophilus influenzae	Breakpoints
-genus_species	is	Haemophilus influenzae	AMP	I	AMX, PIP	I	Haemophilus influenzae	Breakpoints
-genus_species	is	Haemophilus influenzae	AMP	R	AMX, PIP	R	Haemophilus influenzae	Breakpoints
-genus_species	is	Haemophilus influenzae	PEN	S	AMP, AMX, AMC, PIP, TZP	S	Haemophilus influenzae	Breakpoints
-genus_species	is	Haemophilus influenzae	AMC	S	TZP	S	Haemophilus influenzae	Breakpoints
-genus_species	is	Haemophilus influenzae	AMC	I	TZP	I	Haemophilus influenzae	Breakpoints
-genus_species	is	Haemophilus influenzae	AMC	R	TZP	R	Haemophilus influenzae	Breakpoints
-genus_species	is	Haemophilus influenzae	NAL	S	CIP, LVX, MFX, OFX	S	Haemophilus influenzae	Breakpoints
-genus_species	is	Haemophilus influenzae	TCY	S	DOX, MNO	S	Haemophilus influenzae	Breakpoints
-genus_species	is	Moraxella catarrhalis	AMC	S	TZP	S	Moraxella catarrhalis	Breakpoints
-genus_species	is	Moraxella catarrhalis	AMC	I	TZP	I	Moraxella catarrhalis	Breakpoints
-genus_species	is	Moraxella catarrhalis	AMC	R	TZP	R	Moraxella catarrhalis	Breakpoints
-genus_species	is	Moraxella catarrhalis	NAL	S	CIP, LVX, MFX, OFX	S	Moraxella catarrhalis	Breakpoints
-genus_species	is	Moraxella catarrhalis	ERY	S	AZM, CLR, RXT	S	Moraxella catarrhalis	Breakpoints
-genus_species	is	Moraxella catarrhalis	ERY	I	AZM, CLR, RXT	I	Moraxella catarrhalis	Breakpoints
-genus_species	is	Moraxella catarrhalis	ERY	R	AZM, CLR, RXT	R	Moraxella catarrhalis	Breakpoints
-genus_species	is	Moraxella catarrhalis	TCY	S	DOX, MNO	S	Moraxella catarrhalis	Breakpoints
-genus	one_of	Actinomyces, Bifidobacterium, Clostridium, Cutibacterium, Eggerthella, Eubacterium, Lactobacillus, Propionibacterium	PEN	S	AMP, AMX, PIP, TZP, TIC	S	Anaerobic Gram-positives	Breakpoints
-genus	one_of	Actinomyces, Bifidobacterium, Clostridium, Cutibacterium, Eggerthella, Eubacterium, Lactobacillus, Propionibacterium	PEN	I	AMP, AMX, PIP, TZP, TIC	I	Anaerobic Gram-positives	Breakpoints
-genus	one_of	Actinomyces, Bifidobacterium, Clostridium, Cutibacterium, Eggerthella, Eubacterium, Lactobacillus, Propionibacterium	PEN	R	AMP, AMX, PIP, TZP, TIC	R	Anaerobic Gram-positives	Breakpoints
-genus	one_of	Bacteroides, Bilophila , Fusobacterium, Mobiluncus, Porphyromonas, Prevotella	PEN	S	AMP, AMX, PIP, TZP, TIC	S	Anaerobic Gram-negatives	Breakpoints
-genus	one_of	Bacteroides, Bilophila , Fusobacterium, Mobiluncus, Porphyromonas, Prevotella	PEN	I	AMP, AMX, PIP, TZP, TIC	I	Anaerobic Gram-negatives	Breakpoints
-genus	one_of	Bacteroides, Bilophila , Fusobacterium, Mobiluncus, Porphyromonas, Prevotella	PEN	R	AMP, AMX, PIP, TZP, TIC	R	Anaerobic Gram-negatives	Breakpoints
-genus_species	is	Pasteurella multocida	PEN	S	AMP, AMX	S	Pasteurella multocida	Breakpoints
-genus_species	is	Pasteurella multocida	PEN	I	AMP, AMX	I	Pasteurella multocida	Breakpoints
-genus_species	is	Pasteurella multocida	PEN	R	AMP, AMX	R	Pasteurella multocida	Breakpoints
-genus_species	is	Campylobacter coli	ERY	S	AZM, CLR	S	Campylobacter coli	Breakpoints
-genus_species	is	Campylobacter coli	ERY	I	AZM, CLR	I	Campylobacter coli	Breakpoints
-genus_species	is	Campylobacter coli	ERY	R	AZM, CLR	R	Campylobacter coli	Breakpoints
-genus_species	is	Campylobacter coli	TCY	S	DOX	S	Campylobacter coli	Breakpoints
-genus_species	is	Campylobacter coli	TCY	I	DOX	I	Campylobacter coli	Breakpoints
-genus_species	is	Campylobacter coli	TCY	R	DOX	R	Campylobacter coli	Breakpoints
-genus_species	is	Campylobacter jejuni	ERY	S	AZM, CLR	S	Campylobacter jejuni	Breakpoints
-genus_species	is	Campylobacter jejuni	ERY	I	AZM, CLR	I	Campylobacter jejuni	Breakpoints
-genus_species	is	Campylobacter jejuni	ERY	R	AZM, CLR	R	Campylobacter jejuni	Breakpoints
-genus_species	is	Campylobacter jejuni	TCY	S	DOX	S	Campylobacter jejuni	Breakpoints
-genus_species	is	Campylobacter jejuni	TCY	I	DOX	I	Campylobacter jejuni	Breakpoints
-genus_species	is	Campylobacter jejuni	TCY	R	DOX	R	Campylobacter jejuni	Breakpoints
-genus_species	is	Aerococcus sanguinicola	NOR	S	fluoroquinolones	S	Aerococcus sanguinicola	Breakpoints
-genus_species	is	Aerococcus sanguinicola	NOR	I	fluoroquinolones	I	Aerococcus sanguinicola	Breakpoints
-genus_species	is	Aerococcus sanguinicola	NOR	R	fluoroquinolones	R	Aerococcus sanguinicola	Breakpoints
-genus_species	is	Aerococcus sanguinicola	CIP	S	LVX	S	Aerococcus sanguinicola	Breakpoints
-genus_species	is	Aerococcus sanguinicola	CIP	I	LVX	I	Aerococcus sanguinicola	Breakpoints
-genus_species	is	Aerococcus sanguinicola	CIP	R	LVX	R	Aerococcus urinae	Breakpoints
-genus_species	is	Aerococcus urinae	NOR	S	fluoroquinolones	S	Aerococcus urinae	Breakpoints
-genus_species	is	Aerococcus urinae	NOR	I	fluoroquinolones	I	Aerococcus urinae	Breakpoints
-genus_species	is	Aerococcus urinae	NOR	R	fluoroquinolones	R	Aerococcus urinae	Breakpoints
-genus_species	is	Aerococcus urinae	CIP	S	LVX	S	Aerococcus urinae	Breakpoints
-genus_species	is	Aerococcus urinae	CIP	I	LVX	I	Aerococcus urinae	Breakpoints
-genus_species	is	Aerococcus urinae	CIP	R	LVX	R	Aerococcus urinae	Breakpoints
-genus_species	is	Kingella kingae	PEN	S	AMP, AMX	S	Kingella kingae	Breakpoints
-genus_species	is	Kingella kingae	PEN	I	AMP, AMX	I	Kingella kingae	Breakpoints
-genus_species	is	Kingella kingae	PEN	R	AMP, AMX	R	Kingella kingae	Breakpoints
-genus_species	is	Kingella kingae	ERY	S	AZM, CLR	S	Kingella kingae	Breakpoints
-genus_species	is	Kingella kingae	ERY	I	AZM, CLR	I	Kingella kingae	Breakpoints
-genus_species	is	Kingella kingae	ERY	R	AZM, CLR	R	Kingella kingae	Breakpoints
-genus_species	is	Kingella kingae	TCY	S	DOX	S	Kingella kingae	Breakpoints
-order	is	Enterobacterales			PEN, glycopeptides, FUS, macrolides, LIN, streptogramins, RIF, DAP, LNZ	R	Table 01: Intrinsic resistance in Enterobacteriaceae	Expert Rules
-fullname	like	^Citrobacter (koseri|amalonaticus|sedlakii|farmeri|rodentium)			aminopenicillins, TIC	R	Table 01: Intrinsic resistance in Enterobacteriaceae	Expert Rules
-fullname	like	^Citrobacter (freundii|braakii|murliniae|werkmanii|youngae)			aminopenicillins, AMC, CZO, FOX	R	Table 01: Intrinsic resistance in Enterobacteriaceae	Expert Rules
-genus_species	is	Enterobacter cloacae			aminopenicillins, AMC, CZO, FOX	R	Table 01: Intrinsic resistance in Enterobacteriaceae	Expert Rules
-genus_species	is	Enterobacter aerogenes			aminopenicillins, AMC, CZO, FOX	R	Table 01: Intrinsic resistance in Enterobacteriaceae	Expert Rules
-genus_species	is	Escherichia hermanni			aminopenicillins, TIC	R	Table 01: Intrinsic resistance in Enterobacteriaceae	Expert Rules
-genus_species	is	Hafnia alvei			aminopenicillins, AMC, CZO, FOX	R	Table 01: Intrinsic resistance in Enterobacteriaceae	Expert Rules
-genus	is	Klebsiella			aminopenicillins, TIC	R	Table 01: Intrinsic resistance in Enterobacteriaceae	Expert Rules
-genus_species	is	Morganella morganii			aminopenicillins, AMC, CZO, tetracyclines, polymyxins, NIT	R	Table 01: Intrinsic resistance in Enterobacteriaceae	Expert Rules
-genus_species	is	Proteus mirabilis			tetracyclines, TGC, polymyxins, NIT	R	Table 01: Intrinsic resistance in Enterobacteriaceae	Expert Rules
-genus_species	is	Proteus penneri			aminopenicillins, CZO, CXM, tetracyclines, TGC, polymyxins, NIT	R	Table 01: Intrinsic resistance in Enterobacteriaceae	Expert Rules
-genus_species	is	Proteus vulgaris			aminopenicillins, CZO, CXM, tetracyclines, TGC, polymyxins, NIT	R	Table 01: Intrinsic resistance in Enterobacteriaceae	Expert Rules
-genus_species	is	Providencia rettgeri			aminopenicillins, AMC, CZO, CXM, tetracyclines, TGC, polymyxins, NIT	R	Table 01: Intrinsic resistance in Enterobacteriaceae	Expert Rules
-genus_species	is	Providencia stuartii			aminopenicillins, AMC, CZO, CXM, tetracyclines, TGC, polymyxins, NIT	R	Table 01: Intrinsic resistance in Enterobacteriaceae	Expert Rules
-genus	is	Raoultella			aminopenicillins, TIC	R	Table 01: Intrinsic resistance in Enterobacteriaceae	Expert Rules
-genus_species	is	Serratia marcescens			aminopenicillins, AMC, CZO, FOX, CXM, DOX, TCY, polymyxins, NIT	R	Table 01: Intrinsic resistance in Enterobacteriaceae	Expert Rules
-genus_species	is	Yersinia enterocolitica			aminopenicillins, AMC, TIC, CZO, FOX	R	Table 01: Intrinsic resistance in Enterobacteriaceae	Expert Rules
-genus_species	is	Yersinia pseudotuberculosis			PLB, COL	R	Table 01: Intrinsic resistance in Enterobacteriaceae	Expert Rules
-genus	one_of	Achromobacter, Acinetobacter, Alcaligenes, Bordatella, Burkholderia, Elizabethkingia, Flavobacterium, Ochrobactrum, Pseudomonas, Stenotrophomonas			PEN, FOX, CXM, glycopeptides, FUS, macrolides, LIN, streptogramins, RIF, DAP, LNZ	R	Table 02: Intrinsic resistance in non-fermentative Gram-negative bacteria	Expert Rules
-genus_species	is	Acinetobacter baumannii			aminopenicillins, AMC, CZO, CTX, CRO, ATM, ETP, TMP, FOS, DOX, TCY	R	Table 02: Intrinsic resistance in non-fermentative Gram-negative bacteria	Expert Rules
-genus_species	is	Acinetobacter pittii			aminopenicillins, AMC, CZO, CTX, CRO, ATM, ETP, TMP, FOS, DOX, TCY	R	Table 02: Intrinsic resistance in non-fermentative Gram-negative bacteria	Expert Rules
-genus_species	is	Acinetobacter nosocomialis			aminopenicillins, AMC, CZO, CTX, CRO, ATM, ETP, TMP, FOS, DOX, TCY	R	Table 02: Intrinsic resistance in non-fermentative Gram-negative bacteria	Expert Rules
-genus_species	is	Acinetobacter calcoaceticus			aminopenicillins, AMC, CZO, CTX, CRO, ATM, ETP, TMP, FOS, DOX, TCY	R	Table 02: Intrinsic resistance in non-fermentative Gram-negative bacteria	Expert Rules
-genus_species	is	Achromobacter xylosoxidans			aminopenicillins, CZO, CTX, CRO, ETP	R	Table 02: Intrinsic resistance in non-fermentative Gram-negative bacteria	Expert Rules
-fullname	like	^Burkholderia (cepacia|multivorans|cenocepacia|stabilis|vietnamiensis|dolosa|ambifaria|anthina|pyrrocinia|ubonensis)			aminopenicillins, AMC, TIC, PIP, TZP, CZO, CTX, CRO, ATM, ETP, CIP, CHL, aminoglycosides, TMP, FOS, polymyxins	R	Table 02: Intrinsic resistance in non-fermentative Gram-negative bacteria	Expert Rules
-genus_species	is	Elizabethkingia meningoseptica			aminopenicillins, AMC, TIC, CZO, CTX, CRO, CAZ, FEP, ATM, ETP, IPM, MEM, polymyxins	R	Table 02: Intrinsic resistance in non-fermentative Gram-negative bacteria	Expert Rules
-genus_species	is	Ochrobactrum anthropi			aminopenicillins, AMC, TIC, PIP, TZP, CZO, CTX, CRO, CAZ, FEP, ATM, ETP	R	Table 02: Intrinsic resistance in non-fermentative Gram-negative bacteria	Expert Rules
-genus_species	is	Pseudomonas aeruginosa			aminopenicillins, AMC, CZO, CTX, CRO, ETP, CHL, KAN, NEO, TMP, SXT, tetracyclines, TGC	R	Table 02: Intrinsic resistance in non-fermentative Gram-negative bacteria	Expert Rules
-genus_species	is	Stenotrophomonas maltophilia			aminopenicillins, AMC, TIC, PIP, TZP, CZO, CTX, CRO, ATM, ETP, IPM, MEM, aminoglycosides, TMP, FOS, TCY	R	Table 02: Intrinsic resistance in non-fermentative Gram-negative bacteria	Expert Rules
-genus	one_of	Haemophilus, Moraxella, Neisseria, Campylobacter			glycopeptides, LIN, DAP, LNZ	R	Table 03: Intrinsic resistance in other Gram-negative bacteria	Expert Rules
-genus_species	is	Haemophilus influenzae			FUS, streptogramins	R	Table 03: Intrinsic resistance in other Gram-negative bacteria	Expert Rules
-genus_species	is	Moraxella catarrhalis			TMP	R	Table 03: Intrinsic resistance in other Gram-negative bacteria	Expert Rules
-genus	is	Neisseria			TMP	R	Table 03: Intrinsic resistance in other Gram-negative bacteria	Expert Rules
-genus_species	is	Campylobacter fetus			FUS, streptogramins, TMP, NAL	R	Table 03: Intrinsic resistance in other Gram-negative bacteria	Expert Rules
-genus_species	is	Campylobacter jejuni			FUS, streptogramins, TMP	R	Table 03: Intrinsic resistance in other Gram-negative bacteria	Expert Rules
-genus_species	is	Campylobacter coli			FUS, streptogramins, TMP	R	Table 03: Intrinsic resistance in other Gram-negative bacteria	Expert Rules
-gramstain	is	Gram-positive			ATM, polymyxins, NAL	R	Table 04: Intrinsic resistance in Gram-positive bacteria	Expert Rules
-genus_species	is	Staphylococcus saprophyticus			FUS, CAZ, FOS, NOV	R	Table 04: Intrinsic resistance in Gram-positive bacteria	Expert Rules
-genus_species	is	Staphylococcus cohnii			CAZ, NOV	R	Table 04: Intrinsic resistance in Gram-positive bacteria	Expert Rules
-genus_species	is	Staphylococcus xylosus			CAZ, NOV	R	Table 04: Intrinsic resistance in Gram-positive bacteria	Expert Rules
-genus_species	is	Staphylococcus capitis			CAZ, FOS	R	Table 04: Intrinsic resistance in Gram-positive bacteria	Expert Rules
-genus_species	is	Staphylococcus aureus			CAZ	R	Table 04: Intrinsic resistance in Gram-positive bacteria	Expert Rules
-genus_species	is	Staphylococcus epidermidis			CAZ	R	Table 04: Intrinsic resistance in Gram-positive bacteria	Expert Rules
-genus_species	is	Staphylococcus coagulase-negative			CAZ	R	Table 04: Intrinsic resistance in Gram-positive bacteria	Expert Rules
-genus_species	is	Staphylococcus hominis			CAZ	R	Table 04: Intrinsic resistance in Gram-positive bacteria	Expert Rules
-genus_species	is	Staphylococcus haemolyticus			CAZ	R	Table 04: Intrinsic resistance in Gram-positive bacteria	Expert Rules
-genus_species	is	Staphylococcus intermedius			CAZ	R	Table 04: Intrinsic resistance in Gram-positive bacteria	Expert Rules
-genus_species	is	Staphylococcus pseudintermedius			CAZ	R	Table 04: Intrinsic resistance in Gram-positive bacteria	Expert Rules
-genus	is	Streptococcus			FUS, CAZ, aminoglycosides	R	Table 04: Intrinsic resistance in Gram-positive bacteria	Expert Rules
-genus_species	is	Enterococcus faecalis			FUS, CAZ, cephalosporins_except_CAZ, aminoglycosides, macrolides, CLI, QDA, TMP, SXT	R	Table 04: Intrinsic resistance in Gram-positive bacteria	Expert Rules
-genus_species	is	Enterococcus gallinarum			FUS, CAZ, cephalosporins_except_CAZ, aminoglycosides, macrolides, CLI, QDA, VAN, TMP, SXT	R	Table 04: Intrinsic resistance in Gram-positive bacteria	Expert Rules
-genus_species	is	Enterococcus casseliflavus			FUS, CAZ, cephalosporins_except_CAZ, aminoglycosides, macrolides, CLI, QDA, VAN, TMP, SXT	R	Table 04: Intrinsic resistance in Gram-positive bacteria	Expert Rules
-genus_species	is	Enterococcus faecium			FUS, CAZ, cephalosporins_except_CAZ, aminoglycosides, macrolides, TMP, SXT	R	Table 04: Intrinsic resistance in Gram-positive bacteria	Expert Rules
-genus	is	Corynebacterium			FOS	R	Table 04: Intrinsic resistance in Gram-positive bacteria	Expert Rules
-genus_species	is	Listeria monocytogenes			cephalosporins	R	Table 04: Intrinsic resistance in Gram-positive bacteria	Expert Rules
-genus	one_of	Leuconostoc, Pediococcus			glycopeptides	R	Table 04: Intrinsic resistance in Gram-positive bacteria	Expert Rules
-genus	is	Lactobacillus			glycopeptides	R	Table 04: Intrinsic resistance in Gram-positive bacteria	Expert Rules
-genus_species	is	Clostridium ramosum			VAN	R	Table 04: Intrinsic resistance in Gram-positive bacteria	Expert Rules
-genus_species	is	Clostridium innocuum			VAN	R	Table 04: Intrinsic resistance in Gram-positive bacteria	Expert Rules
-genus_species	like	^Streptococcus (pyogenes|agalactiae|dysgalactiae|group A|group B|group C|group G)	PEN	S	aminopenicillins, cephalosporins_except_CAZ, carbapenems	S	Table 08: Interpretive rules for B-lactam agents and Gram-positive cocci	Expert Rules
-genus	is	Enterococcus	AMP	R	ureidopenicillins, carbapenems	R	Table 08: Interpretive rules for B-lactam agents and Gram-positive cocci	Expert Rules
-genus	is	Enterococcus	AMX	R	ureidopenicillins, carbapenems	R	Table 08: Interpretive rules for B-lactam agents and Gram-positive cocci	Expert Rules
-family	is	Enterobacteriaceae	TIC, PIP	R, S	PIP	R	Table 09: Interpretive rules for B-lactam agents and Gram-negative rods	Expert Rules
-genus	like	.*	ERY	S	AZM, CLR	S	Table 11: Interpretive rules for macrolides, lincosamides, and streptogramins	Expert Rules
-genus	like	.*	ERY	I	AZM, CLR	I	Table 11: Interpretive rules for macrolides, lincosamides, and streptogramins	Expert Rules
-genus	like	.*	ERY	R	AZM, CLR	R	Table 11: Interpretive rules for macrolides, lincosamides, and streptogramins	Expert Rules
-genus	is	Staphylococcus	TOB	R	KAN, AMK	R	Table 12: Interpretive rules for aminoglycosides	Expert Rules
-genus	is	Staphylococcus	GEN	R	aminoglycosides	R	Table 12: Interpretive rules for aminoglycosides	Expert Rules
-order	is	Enterobacterales	GEN, TOB	I, S	GEN	R	Table 12: Interpretive rules for aminoglycosides	Expert Rules
-order	is	Enterobacterales	GEN, TOB	R, I	TOB	R	Table 12: Interpretive rules for aminoglycosides	Expert Rules
-genus	is	Staphylococcus	MFX	R	fluoroquinolones	R	Table 13: Interpretive rules for quinolones	Expert Rules
-genus_species	is	Streptococcus pneumoniae	MFX	R	fluoroquinolones	R	Table 13: Interpretive rules for quinolones	Expert Rules
-order	is	Enterobacterales	CIP	R	fluoroquinolones	R	Table 13: Interpretive rules for quinolones	Expert Rules
-genus_species	is	Neisseria gonorrhoeae	CIP	R	fluoroquinolones	R	Table 13: Interpretive rules for quinolones	Expert Rules

data-raw/internals.R

@@ -1,61 +0,0 @@
-# Run this file to update the package -------------------------------------
-# source("data-raw/internals.R")
-
-# See 'data-raw/eucast_rules.tsv' for the EUCAST reference file
-eucast_rules_file <- utils::read.delim(file = "data-raw/eucast_rules.tsv",
-                            skip = 10,
-                            sep = "\t",
-                            stringsAsFactors = FALSE,
-                            header = TRUE,
-                            strip.white = TRUE,
-                            na = c(NA, "", NULL))
-# take the order of the reference.rule_group column in the orginal data file
-eucast_rules_file$reference.rule_group <- factor(eucast_rules_file$reference.rule_group,
-                                                 levels = unique(eucast_rules_file$reference.rule_group),
-                                                 ordered = TRUE)
-eucast_rules_file <- dplyr::arrange(eucast_rules_file,
-  reference.rule_group,
-  reference.rule)
-eucast_rules_file$reference.rule_group <- as.character(eucast_rules_file$reference.rule_group)
-
-# Translations ----
-translations_file <- utils::read.delim(file = "data-raw/translations.tsv",
-                                       sep = "\t",
-                                       stringsAsFactors = FALSE,
-                                       header = TRUE,
-                                       blank.lines.skip = TRUE,
-                                       fill = TRUE,
-                                       strip.white = TRUE,
-                                       encoding = "UTF-8",
-                                       fileEncoding = "UTF-8",
-                                       na.strings = c(NA, "", NULL),
-                                       allowEscapes = TRUE, # else "\\1" will be imported as "\\\\1"
-                                       quote = "")
-
-# Old microorganism codes -------------------------------------------------
-
-microorganisms.translation <- readRDS("data-raw/microorganisms.translation.rds")
-
-# Export to package as internal data ----
-usethis::use_data(eucast_rules_file, translations_file, microorganisms.translation,
-                  internal = TRUE,
-                  overwrite = TRUE,
-                  version = 2)
-
-# Remove from global environment ----
-rm(eucast_rules_file)
-rm(translations_file)
-rm(microorganisms.translation)
-
-# Clean mo history ----
-usethis::ui_done(paste0("Resetting {usethis::ui_value('mo_history.csv')}"))
-tryCatch(
-  write.csv(x = data.frame(x = character(0),
-                           mo = character(0),
-                           uncertainty_level = integer(0),
-                           package_version = character(0),
-                           stringsAsFactors = FALSE),
-            row.names = FALSE,
-            file = "inst/mo_history/mo_history.csv"),
-  warning = function(w) cat("Warning:", w$message, "\n"),
-  error = function(e) cat("Error:", e$message, "\n"))

data-raw/reproduction_of_antibiotics.R

@@ -1,391 +0,0 @@
-# ==================================================================== #
-# TITLE                                                                #
-# Antimicrobial Resistance (AMR) Analysis                              #
-#                                                                      #
-# SOURCE                                                               #
-# https://gitlab.com/msberends/AMR                                     #
-#                                                                      #
-# LICENCE                                                              #
-# (c) 2019 Berends MS (m.s.berends@umcg.nl), Luz CF (c.f.luz@umcg.nl)  #
-#                                                                      #
-# This R package is free software; you can freely use and distribute   #
-# it for both personal and commercial purposes under the terms of the  #
-# GNU General Public License version 2.0 (GNU GPL-2), as published by  #
-# the Free Software Foundation.                                        #
-#                                                                      #
-# This R package was created for academic research and was publicly    #
-# released in the hope that it will be useful, but it comes WITHOUT    #
-# ANY WARRANTY OR LIABILITY.                                           #
-# Visit our website for more info: https://msberends.gitlab.io/AMR.    #
-# ==================================================================== #
-
-library(dplyr)
-
-# got EARS-Net codes (= ECDC/WHO codes) from here:
-
-# Installed WHONET 2019 software on Windows (http://www.whonet.org/software.html),
-#    opened C:\WHONET\Codes\WHONETCodes.mdb in MS Access
-#    and exported table 'DRGLST' to MS Excel
-library(readxl)
-DRGLST <- read_excel("DRGLST.xlsx")
-abx <- DRGLST %>%
-  select(ab = WHON5_CODE,
-         name = ANTIBIOTIC) %>%
-  # remove the ones without WHONET code
-  filter(!is.na(ab)) %>%
-  distinct(name, .keep_all = TRUE) %>%
-  # add the ones without WHONET code
-  bind_rows(
-    DRGLST %>%
-      select(ab = WHON5_CODE,
-             name = ANTIBIOTIC) %>%
-      filter(is.na(ab)) %>%
-      distinct(name, .keep_all = TRUE)
-      # add new ab code later
-  ) %>%
-  arrange(name)
-
-# add old ATC codes
-ab_old <- AMR::antibiotics %>%
-  mutate(official = gsub("( and |, )", "/", official),
-         abbr = tolower(paste(ifelse(is.na(abbr), "", abbr),
-                      ifelse(is.na(certe), "", certe),
-                      ifelse(is.na(umcg), "", umcg),
-                      sep = "|")))
-for (i in 1:nrow(ab_old)) {
-  abbr <- ab_old[i, "abbr"]
-  abbr <- strsplit(abbr, "|", fixed = TRUE) %>% unlist() %>% unique()
-  abbr <- abbr[abbr != ""]
-  #print(abbr)
-  if (length(abbr) == 0) {
-    ab_old[i, "abbr"] <- NA_character_
-  } else {
-    ab_old[i, "abbr"] <- paste(abbr, collapse = "|")
-  }
-}
-
-# create reference data set: to be able to map ab to atc
-abx_atc1 <- abx %>%
-  mutate(name_lower = tolower(name)) %>%
-  left_join(ab_old %>%
-              select(ears_net, atc), by = c(ab = "ears_net")) %>%
-  rename(atc1 = atc) %>%
-  left_join(ab_old %>%
-              mutate(official = gsub(", combinations", "", official, fixed = TRUE)) %>%
-              transmute(official = tolower(official), atc), by = c(name_lower = "official")) %>%
-  rename(atc2 = atc) %>%
-  left_join(ab_old %>%
-              mutate(official = gsub(", combinations", "", official, fixed = TRUE)) %>%
-              mutate(official = gsub("f", "ph", official)) %>%
-              transmute(official = tolower(official), atc), by = c(name_lower = "official")) %>%
-  rename(atc3 = atc) %>%
-  left_join(ab_old %>%
-              mutate(official = gsub(", combinations", "", official, fixed = TRUE)) %>%
-              mutate(official = gsub("t", "th", official)) %>%
-              transmute(official = tolower(official), atc), by = c(name_lower = "official")) %>%
-  rename(atc4 = atc) %>%
-  left_join(ab_old %>%
-              mutate(official = gsub(", combinations", "", official, fixed = TRUE)) %>%
-              mutate(official = gsub("f", "ph", official)) %>%
-              mutate(official = gsub("t", "th", official)) %>%
-              transmute(official = tolower(official), atc), by = c(name_lower = "official")) %>%
-  rename(atc5 = atc) %>%
-  left_join(ab_old %>%
-              mutate(official = gsub(", combinations", "", official, fixed = TRUE)) %>%
-              mutate(official = gsub("f", "ph", official)) %>%
-              mutate(official = gsub("t", "th", official)) %>%
-              mutate(official = gsub("ine$", "in", official)) %>%
-              transmute(official = tolower(official), atc), by = c(name_lower = "official")) %>%
-  rename(atc6 = atc) %>%
-  mutate(atc = case_when(!is.na(atc1) ~ atc1,
-                         !is.na(atc2) ~ atc2,
-                         !is.na(atc3) ~ atc3,
-                         !is.na(atc4) ~ atc4,
-                         !is.na(atc4) ~ atc5,
-                         TRUE ~ atc6)) %>%
-  distinct(ab, name, .keep_all = TRUE) %>%
-  select(ab, atc, name)
-
-abx_atc2 <- ab_old %>%
-  filter(!atc %in% abx_atc1$atc,
-         is.na(ears_net),
-         !is.na(atc_group1),
-         !atc_group1 %like% ("virus|vaccin|viral|immun"),
-         !official %like% "(combinations| with )") %>%
-  mutate(ab = NA_character_) %>%
-  as.data.frame(stringsAsFactors = FALSE) %>%
-  select(ab, atc, name = official)
-
-abx2 <- bind_rows(abx_atc1, abx_atc2)
-
-rm(abx_atc1)
-rm(abx_atc2)
-
-abx2$ab[is.na(abx2$ab)] <- toupper(abbreviate(gsub("[/0-9-]",
-                                                   " ",
-                                                   abx2$name[is.na(abx2$ab)]),
-                                              minlength = 3,
-                                              method = "left.kept",
-                                              strict = TRUE))
-
-n_distinct(abx2$ab)
-
-abx2 <- abx2 %>% arrange(ab)
-seqnr <- 0
-# add follow up nrs
-for (i in 2:nrow(abx2)) {
-  if (abx2[i, "ab"] == abx2[i - 1, "ab"]) {
-    seqnr <- seqnr + 1
-    abx2[i, "seqnr"] <- seqnr
-  } else {
-    seqnr <- 0
-  }
-}
-for (i in 2:nrow(abx2)) {
-  if (!is.na(abx2[i, "seqnr"])) {
-    abx2[i, "ab"] <- paste0(abx2[i, "ab"], abx2[i, "seqnr"])
-  }
-}
-abx2 <- abx2 %>% select(-seqnr) %>% arrange(name)
-
-# everything unique??
-nrow(abx2) == n_distinct(abx2$ab)
-
-# get ATC properties
-abx2 <- abx2 %>%
-  left_join(ab_old %>%
-              select(atc, abbr, atc_group1, atc_group2,
-                     oral_ddd, oral_units, iv_ddd, iv_units))
-
-abx2$abbr <- lapply(as.list(abx2$abbr), function(x) unlist(strsplit(x, "|", fixed = TRUE)))
-
-# vector with official names, returns vector with CIDs
-get_CID <- function(ab) {
-  CID <- rep(NA_integer_, length(ab))
-  p <- progress_estimated(n = length(ab), min_time = 0)
-  for (i in 1:length(ab)) {
-    p$tick()$print()
-
-    CID[i] <- tryCatch(
-      data.table::fread(paste0("https://pubchem.ncbi.nlm.nih.gov/rest/pug/compound/name/",
-                               URLencode(ab[i], reserved = TRUE),
-                               "/cids/TXT?name_type=complete"),
-                        showProgress = FALSE)[[1]][1],
-      error = function(e) NA_integer_)
-    if (is.na(CID[i])) {
-      # try with removing the text in brackets
-      CID[i] <- tryCatch(
-        data.table::fread(paste0("https://pubchem.ncbi.nlm.nih.gov/rest/pug/compound/name/",
-                                 URLencode(trimws(gsub("[(].*[)]", "", ab[i])), reserved = TRUE),
-                                 "/cids/TXT?name_type=complete"),
-                          showProgress = FALSE)[[1]][1],
-        error = function(e) NA_integer_)
-    }
-    if (is.na(CID[i])) {
-      # try match on word and take the lowest CID value (sorted)
-      ab[i] <- gsub("[^a-z0-9]+", " ", ab[i], ignore.case = TRUE)
-      CID[i] <- tryCatch(
-        data.table::fread(paste0("https://pubchem.ncbi.nlm.nih.gov/rest/pug/compound/name/",
-                                 URLencode(ab[i], reserved = TRUE),
-                                 "/cids/TXT?name_type=word"),
-                          showProgress = FALSE)[[1]][1],
-        error = function(e) NA_integer_)
-    }
-    Sys.sleep(0.1)
-  }
-  CID
-}
-
-# get CIDs (2-3 min)
-CIDs <- get_CID(abx2$name)
-# These could not be found:
-abx2[is.na(CIDs),] %>% View()
-
-# returns list with synonyms (brand names), with CIDs as names
-get_synonyms <- function(CID, clean = TRUE) {
-  synonyms <- rep(NA_character_, length(CID))
-  p <- progress_estimated(n = length(CID), min_time = 0)
-
-  for (i in 1:length(CID)) {
-    p$tick()$print()
-
-    synonyms_txt <- ""
-
-    if (is.na(CID[i])) {
-      next
-    }
-
-    synonyms_txt <- tryCatch(
-      data.table::fread(paste0("https://pubchem.ncbi.nlm.nih.gov/rest/pug/compound/fastidentity/cid/",
-                               CID[i],
-                               "/synonyms/TXT"),
-                        sep = "\n",
-                        showProgress = FALSE)[[1]],
-      error = function(e) NA_character_)
-
-    Sys.sleep(0.1)
-
-    if (clean == TRUE) {
-      # remove text between brackets
-      synonyms_txt <- trimws(gsub("[(].*[)]", "",
-                                  gsub("[[].*[]]", "",
-                                       gsub("[(].*[]]", "",
-                                            gsub("[[].*[)]", "", synonyms_txt)))))
-      synonyms_txt <- gsub("Co-", "Co", synonyms_txt, fixed = TRUE)
-      # only length 6 to 20 and no txt with reading marks or numbers and must start with capital letter (= brand)
-      synonyms_txt <- synonyms_txt[nchar(synonyms_txt) %in% c(6:20)
-                                   & !grepl("[-&{},_0-9/]", synonyms_txt)
-                                   & grepl("^[A-Z]", synonyms_txt, ignore.case = FALSE)]
-      synonyms_txt <- unlist(strsplit(synonyms_txt,  ";", fixed = TRUE))
-    }
-    synonyms_txt <- unique(trimws(synonyms_txt[tolower(synonyms_txt) %in% unique(tolower(synonyms_txt))]))
-    synonyms[i] <- list(sort(synonyms_txt))
-  }
-  names(synonyms) <- CID
-  synonyms
-}
-
-# get brand names from PubChem (2-3 min)
-synonyms <- get_synonyms(CIDs)
-synonyms <- lapply(synonyms,
-                   function(x) {
-                     if (length(x) == 0 | all(is.na(x))) {
-                       ""
-                     } else {
-                       x
-                     }})
-
-# add them to data set
-antibiotics <- abx2 %>%
-  left_join(DRGLST %>%
-              select(ab = WHON5_CODE, CLASS, SUBCLASS) %>%
-              distinct(ab, .keep_all = TRUE), by = "ab") %>%
-  transmute(ab,
-            atc,
-            cid = CIDs,
-            # no capital after a slash: Ampicillin/Sulbactam -> Ampicillin/sulbactam
-            name = name %>%
-              gsub("([/-])([A-Z])", "\\1\\L\\2", ., perl = TRUE) %>%
-              gsub("edta", "EDTA", ., ignore.case = TRUE),
-            group = case_when(
-              paste(atc_group1, atc_group2, CLASS, SUBCLASS) %like% "am(ph|f)enicol" ~ "Amphenicols",
-              paste(atc_group1, atc_group2, CLASS, SUBCLASS) %like% "aminoglycoside" ~ "Aminoglycosides",
-              paste(atc_group1, atc_group2, CLASS, SUBCLASS) %like% "carbapenem" | name %like% "(imipenem|meropenem)" ~ "Carbapenems",
-              paste(atc_group1, atc_group2, CLASS, SUBCLASS) %like% "First-generation cephalosporin" ~ "Cephalosporins (1st gen.)",
-              paste(atc_group1, atc_group2, CLASS, SUBCLASS) %like% "Second-generation cephalosporin" ~ "Cephalosporins (2nd gen.)",
-              paste(atc_group1, atc_group2, CLASS, SUBCLASS) %like% "Third-generation cephalosporin" ~ "Cephalosporins (3rd gen.)",
-              paste(atc_group1, atc_group2, CLASS, SUBCLASS) %like% "Fourth-generation cephalosporin" ~ "Cephalosporins (4th gen.)",
-              paste(atc_group1, atc_group2, CLASS, SUBCLASS) %like% "(tuberculosis|mycobacter)" ~ "Antimycobacterials",
-              paste(atc_group1, atc_group2, CLASS, SUBCLASS) %like% "cephalosporin" ~ "Cephalosporins",
-              name %like% "^Ce" & is.na(atc_group1) & paste(atc_group1, atc_group2, CLASS, SUBCLASS) %like% "beta-?lactam" ~ "Cephalosporins",
-              paste(atc_group1, atc_group2, CLASS, SUBCLASS) %like% "(beta-?lactam|penicillin)" ~ "Beta-lactams/penicillins",
-              paste(atc_group1, atc_group2, CLASS, SUBCLASS) %like% "quinolone" ~ "Quinolones",
-              paste(atc_group1, atc_group2, CLASS, SUBCLASS) %like% "glycopeptide" ~ "Glycopeptides",
-              paste(atc_group1, atc_group2, CLASS, SUBCLASS) %like% "macrolide" ~ "Macrolides/lincosamides",
-              paste(atc_group1, atc_group2, CLASS, SUBCLASS) %like% "tetracycline" ~ "Tetracyclines",
-              paste(atc_group1, atc_group2, CLASS, SUBCLASS) %like% "trimethoprim" ~ "Trimethoprims",
-              paste(atc_group1, atc_group2, CLASS, SUBCLASS) %like% "polymyxin" ~ "Polymyxins",
-              paste(atc_group1, atc_group2, CLASS, SUBCLASS) %like% "(fungal|mycot)" ~ "Antifungals/antimycotics",
-              TRUE ~ "Other antibacterials"
-            ),
-            atc_group1, atc_group2,
-            abbreviations = unname(abbr),
-            synonyms = unname(synonyms),
-            oral_ddd, oral_units,
-            iv_ddd, iv_units) %>%
-  as.data.frame(stringsAsFactors = FALSE)
-
-# some exceptions
-antibiotics[which(antibiotics$ab == "DOX"), "abbreviations"][[1]] <- list(c("dox", "doxy"))
-antibiotics[which(antibiotics$ab == "FLC"), "abbreviations"][[1]] <- list(c("clox"))
-antibiotics[which(antibiotics$ab == "CEC"), "abbreviations"][[1]] <- list(c(antibiotics[which(antibiotics$ab == "CEC"), "abbreviations"][[1]], "CFC")) # cefaclor old WHONET4 code
-antibiotics[which(antibiotics$ab == "AMX"), "synonyms"][[1]] <- list(sort(c(antibiotics[which(antibiotics$ab == "AMX"), "synonyms"][[1]], "Amoxy")))
-# 'Polymixin B' (POL) and 'Polymyxin B' (PLB) both exist, so:
-antibiotics[which(antibiotics$ab == "PLB"), "abbreviations"][[1]] <- list(c(antibiotics[which(antibiotics$ab == "PLB"), "abbreviations"][[1]], "POL", "Polymixin", "Polymixin B"))
-antibiotics <- filter(antibiotics, ab != "POL")
-# 'Latamoxef' (LTM) and 'Moxalactam (Latamoxef)' (MOX) both exist, so:
-antibiotics[which(antibiotics$ab == "LTM"), "abbreviations"][[1]] <- list(c("MOX", "moxa"))
-antibiotics <- filter(antibiotics, ab != "MOX")
-# RFP and RFP1 (the J0 one) both mean 'rifapentine', although 'rifp' is not recognised, so:
-antibiotics <- filter(antibiotics, ab != "RFP")
-antibiotics[which(antibiotics$ab == "RFP1"), "ab"] <- "RFP"
-antibiotics[which(antibiotics$ab == "RFP"), "abbreviations"][[1]] <- list(c("rifp"))
-# Rifampicin is better known as a drug than Rifampin (Rifampin is still listed as a brand name), so:
-antibiotics[which(antibiotics$ab == "RIF"), "name"] <- "Rifampicin"
-# PME and PVM1 (the J0 one) both mean 'Pivmecillinam', so:
-antibiotics <- filter(antibiotics, ab != "PME")
-antibiotics[which(antibiotics$ab == "PVM1"), "ab"] <- "PME"
-# Remove Sinecatechins
-antibiotics <- filter(antibiotics, ab != "SNC")
-# ESBL E-test codes:
-antibiotics[which(antibiotics$ab == "CCV"), "abbreviations"][[1]] <- list(c("xtzl"))
-antibiotics[which(antibiotics$ab == "CAZ"), "abbreviations"][[1]] <- list(c(antibiotics[which(antibiotics$ab == "CAZ"), "abbreviations"][[1]], "xtz", "cefta"))
-antibiotics[which(antibiotics$ab == "CPC"), "abbreviations"][[1]] <- list(c("xpml"))
-antibiotics[which(antibiotics$ab == "FEP"), "abbreviations"][[1]] <- list(c(antibiotics[which(antibiotics$ab == "FEP"), "abbreviations"][[1]], "xpm"))
-antibiotics[which(antibiotics$ab == "CTC"), "abbreviations"][[1]] <- list(c("xctl"))
-antibiotics[which(antibiotics$ab == "CTX"), "abbreviations"][[1]] <- list(c(antibiotics[which(antibiotics$ab == "CTX"), "abbreviations"][[1]], "xct"))
-# High level Gentamcin and Streptomycin
-antibiotics[which(antibiotics$ab == "GEH"), "abbreviations"][[1]] <- list(c("gehl", "gentamicin high", "genta high"))
-antibiotics[which(antibiotics$ab == "STH"), "abbreviations"][[1]] <- list(c("sthl", "streptomycin high", "strepto high"))
-# add imi to imipenem
-antibiotics[which(antibiotics$ab == "IPM"), "abbreviations"][[1]] <- list(c("imip", "imi", "imp"))
-
-## new ATC codes
-# ceftaroline
-antibiotics[which(antibiotics$ab == "CPT"), "atc"] <- "J01DI02"
-# faropenem
-antibiotics[which(antibiotics$ab == "FAR"), "atc"] <- "J01DI03"
-# ceftobiprole
-antibiotics[which(antibiotics$ab == "BPR"), "atc"] <- "J01DI01"
-
-# typo
-antibiotics[which(antibiotics$ab == "RXT"), "name"] <- "Roxithromycin"
-
-antibiotics[which(antibiotics$ab == "PEN"), "atc"] <- "J01CE01"
-
-
-antibiotics <- antibiotics %>% arrange(name)
-
-# set cephalosporins groups for the ones that could not be determined automatically:
-antibiotics <- antibiotics %>% 
-  mutate(group = case_when(
-    name == "Cefcapene" ~ "Cephalosporins (3rd gen.)",
-    name == "Cefcapene pivoxil" ~ "Cephalosporins (3rd gen.)",
-    name == "Cefditoren pivoxil" ~ "Cephalosporins (3rd gen.)",
-    name == "Cefepime/clavulanic acid" ~ "Cephalosporins (4th gen.)",
-    name == "Cefepime/tazobactam" ~ "Cephalosporins (4th gen.)",
-    name == "Cefetamet pivoxil" ~ "Cephalosporins (3rd gen.)",
-    name == "Cefetecol (Cefcatacol)" ~ "Cephalosporins (4th gen.)",
-    name == "Cefetrizole" ~ "Cephalosporins (unclassified gen.)",
-    name == "Cefoselis" ~ "Cephalosporins (4th gen.)",
-    name == "Cefotaxime/clavulanic acid" ~ "Cephalosporins (3rd gen.)",
-    name == "Cefotaxime/sulbactam" ~ "Cephalosporins (3rd gen.)",
-    name == "Cefotiam hexetil" ~ "Cephalosporins (3rd gen.)",
-    name == "Cefovecin" ~ "Cephalosporins (3rd gen.)",
-    name == "Cefozopran" ~ "Cephalosporins (4th gen.)",
-    name == "Cefpimizole" ~ "Cephalosporins (3rd gen.)",
-    name == "Cefpodoxime proxetil" ~ "Cephalosporins (3rd gen.)",
-    name == "Cefpodoxime/clavulanic acid" ~ "Cephalosporins (3rd gen.)",
-    name == "Cefquinome" ~ "Cephalosporins (4th gen.)",
-    name == "Cefsumide" ~ "Cephalosporins (unclassified gen.)",
-    name == "Ceftaroline" ~ "Cephalosporins (5th gen.)",
-    name == "Ceftaroline/avibactam" ~ "Cephalosporins (5th gen.)",
-    name == "Ceftazidime/avibactam" ~ "Cephalosporins (3rd gen.)",
-    name == "Cefteram" ~ "Cephalosporins (3rd gen.)",
-    name == "Cefteram pivoxil" ~ "Cephalosporins (3rd gen.)",
-    name == "Ceftiofur" ~ "Cephalosporins (3rd gen.)",
-    name == "Ceftizoxime alapivoxil" ~ "Cephalosporins (3rd gen.)",
-    name == "Ceftobiprole" ~ "Cephalosporins (5th gen.)",
-    name == "Ceftobiprole medocaril" ~ "Cephalosporins (5th gen.)",
-    name == "Ceftolozane/enzyme inhibitor" ~ "Cephalosporins (5th gen.)",
-    name == "Ceftolozane/tazobactam" ~ "Cephalosporins (5th gen.)",
-    name == "Cefuroxime axetil" ~ "Cephalosporins (2nd gen.)",
-    TRUE ~ group))
-
-# set as data.frame again
-antibiotics <- as.data.frame(antibiotics, stringsAsFactors = FALSE)
-class(antibiotics$ab) <- "ab"
-
-dim(antibiotics) # for R/data.R
-usethis::use_data(antibiotics, overwrite = TRUE)
-rm(antibiotics)