(v2.1.1.9236) documentation

This commit is contained in:
dr. M.S. (Matthijs) Berends committed 2025-04-12 11:46:42 +02:00
1 parent 36fd99e1f4
commit 40d7a971c3
141 files changed
+181 -172

No files matched your search

+1 -1
View File
@@ -24,7 +24,7 @@
# useful, but it comes WITHOUT ANY WARRANTY OR LIABILITY. #
# #
# Visit our website for the full manual and a complete tutorial about #
# how to conduct AMR data analysis: https://amr-for-r.org/ #
# how to conduct AMR data analysis: https://amr-for-r.org #
# ==================================================================== #
#' The `AMR` Package
+1 -1
View File
@@ -24,7 +24,7 @@
# useful, but it comes WITHOUT ANY WARRANTY OR LIABILITY. #
# #
# Visit our website for the full manual and a complete tutorial about #
# how to conduct AMR data analysis: https://amr-for-r.org/ #
# how to conduct AMR data analysis: https://amr-for-r.org #
# ==================================================================== #
# add new version numbers here, and add the rules themselves to "data-raw/eucast_rules.tsv" and clinical_breakpoints
+1 -1
View File
@@ -24,7 +24,7 @@
# useful, but it comes WITHOUT ANY WARRANTY OR LIABILITY. #
# #
# Visit our website for the full manual and a complete tutorial about #
# how to conduct AMR data analysis: https://amr-for-r.org/ #
# how to conduct AMR data analysis: https://amr-for-r.org #
# ==================================================================== #
# faster implementation of left_join than using merge() by poorman - we use match():
+1 -1
View File
@@ -24,7 +24,7 @@
# useful, but it comes WITHOUT ANY WARRANTY OR LIABILITY. #
# #
# Visit our website for the full manual and a complete tutorial about #
# how to conduct AMR data analysis: https://amr-for-r.org/ #
# how to conduct AMR data analysis: https://amr-for-r.org #
# ==================================================================== #
# ------------------------------------------------
+1 -1
View File
@@ -24,7 +24,7 @@
# useful, but it comes WITHOUT ANY WARRANTY OR LIABILITY. #
# #
# Visit our website for the full manual and a complete tutorial about #
# how to conduct AMR data analysis: https://amr-for-r.org/ #
# how to conduct AMR data analysis: https://amr-for-r.org #
# ==================================================================== #
#' Options for the AMR package
+1 -1
View File
@@ -24,7 +24,7 @@
# useful, but it comes WITHOUT ANY WARRANTY OR LIABILITY. #
# #
# Visit our website for the full manual and a complete tutorial about #
# how to conduct AMR data analysis: https://amr-for-r.org/ #
# how to conduct AMR data analysis: https://amr-for-r.org #
# ==================================================================== #
#' Transform Input to an Antibiotic ID
+1 -1
View File
@@ -24,7 +24,7 @@
# useful, but it comes WITHOUT ANY WARRANTY OR LIABILITY. #
# #
# Visit our website for the full manual and a complete tutorial about #
# how to conduct AMR data analysis: https://amr-for-r.org/ #
# how to conduct AMR data analysis: https://amr-for-r.org #
# ==================================================================== #
#' Retrieve Antimicrobial Drug Names and Doses from Clinical Text
+1 -1
View File
@@ -24,7 +24,7 @@
# useful, but it comes WITHOUT ANY WARRANTY OR LIABILITY. #
# #
# Visit our website for the full manual and a complete tutorial about #
# how to conduct AMR data analysis: https://amr-for-r.org/ #
# how to conduct AMR data analysis: https://amr-for-r.org #
# ==================================================================== #
#' Get Properties of an Antibiotic
+1 -1
View File
@@ -24,7 +24,7 @@
# useful, but it comes WITHOUT ANY WARRANTY OR LIABILITY. #
# #
# Visit our website for the full manual and a complete tutorial about #
# how to conduct AMR data analysis: https://amr-for-r.org/ #
# how to conduct AMR data analysis: https://amr-for-r.org #
# ==================================================================== #
#' Age in Years of Individuals
+1 -1
View File
@@ -24,7 +24,7 @@
# useful, but it comes WITHOUT ANY WARRANTY OR LIABILITY. #
# #
# Visit our website for the full manual and a complete tutorial about #
# how to conduct AMR data analysis: https://amr-for-r.org/ #
# how to conduct AMR data analysis: https://amr-for-r.org #
# ==================================================================== #
#' Antimicrobial Selectors
+1 -1
View File
@@ -24,7 +24,7 @@
# useful, but it comes WITHOUT ANY WARRANTY OR LIABILITY. #
# #
# Visit our website for the full manual and a complete tutorial about #
# how to conduct AMR data analysis: https://amr-for-r.org/ #
# how to conduct AMR data analysis: https://amr-for-r.org #
# ==================================================================== #
#' Generate Traditional, Combination, Syndromic, or WISCA Antibiograms
+1 -1
View File
@@ -24,7 +24,7 @@
# useful, but it comes WITHOUT ANY WARRANTY OR LIABILITY. #
# #
# Visit our website for the full manual and a complete tutorial about #
# how to conduct AMR data analysis: https://amr-for-r.org/ #
# how to conduct AMR data analysis: https://amr-for-r.org #
# ==================================================================== #
#' Get ATC Properties from WHOCC Website
+1 -1
View File
@@ -24,7 +24,7 @@
# useful, but it comes WITHOUT ANY WARRANTY OR LIABILITY. #
# #
# Visit our website for the full manual and a complete tutorial about #
# how to conduct AMR data analysis: https://amr-for-r.org/ #
# how to conduct AMR data analysis: https://amr-for-r.org #
# ==================================================================== #
#' Transform Input to an Antiviral Drug ID
+1 -1
View File
@@ -24,7 +24,7 @@
# useful, but it comes WITHOUT ANY WARRANTY OR LIABILITY. #
# #
# Visit our website for the full manual and a complete tutorial about #
# how to conduct AMR data analysis: https://amr-for-r.org/ #
# how to conduct AMR data analysis: https://amr-for-r.org #
# ==================================================================== #
#' Retrieve Antiviral Drug Names and Doses from Clinical Text
+1 -1
View File
@@ -24,7 +24,7 @@
# useful, but it comes WITHOUT ANY WARRANTY OR LIABILITY. #
# #
# Visit our website for the full manual and a complete tutorial about #
# how to conduct AMR data analysis: https://amr-for-r.org/ #
# how to conduct AMR data analysis: https://amr-for-r.org #
# ==================================================================== #
#' Get Properties of an Antiviral Drug
+1 -1
View File
@@ -24,7 +24,7 @@
# useful, but it comes WITHOUT ANY WARRANTY OR LIABILITY. #
# #
# Visit our website for the full manual and a complete tutorial about #
# how to conduct AMR data analysis: https://amr-for-r.org/ #
# how to conduct AMR data analysis: https://amr-for-r.org #
# ==================================================================== #
#' Check Availability of Columns
+1 -1
View File
@@ -24,7 +24,7 @@
# useful, but it comes WITHOUT ANY WARRANTY OR LIABILITY. #
# #
# Visit our website for the full manual and a complete tutorial about #
# how to conduct AMR data analysis: https://amr-for-r.org/ #
# how to conduct AMR data analysis: https://amr-for-r.org #
# ==================================================================== #
#' Determine Bug-Drug Combinations
+1 -1
View File
@@ -24,7 +24,7 @@
# useful, but it comes WITHOUT ANY WARRANTY OR LIABILITY. #
# #
# Visit our website for the full manual and a complete tutorial about #
# how to conduct AMR data analysis: https://amr-for-r.org/ #
# how to conduct AMR data analysis: https://amr-for-r.org #
# ==================================================================== #
#' Count Available Isolates
+1 -1
View File
@@ -24,7 +24,7 @@
# useful, but it comes WITHOUT ANY WARRANTY OR LIABILITY. #
# #
# Visit our website for the full manual and a complete tutorial about #
# how to conduct AMR data analysis: https://amr-for-r.org/ #
# how to conduct AMR data analysis: https://amr-for-r.org #
# ==================================================================== #
#' Add Custom Antimicrobials
+1 -1
View File
@@ -24,7 +24,7 @@
# useful, but it comes WITHOUT ANY WARRANTY OR LIABILITY. #
# #
# Visit our website for the full manual and a complete tutorial about #
# how to conduct AMR data analysis: https://amr-for-r.org/ #
# how to conduct AMR data analysis: https://amr-for-r.org #
# ==================================================================== #
#' Define Custom EUCAST Rules
+1 -1
View File
@@ -24,7 +24,7 @@
# useful, but it comes WITHOUT ANY WARRANTY OR LIABILITY. #
# #
# Visit our website for the full manual and a complete tutorial about #
# how to conduct AMR data analysis: https://amr-for-r.org/ #
# how to conduct AMR data analysis: https://amr-for-r.org #
# ==================================================================== #
#' Add Custom Microorganisms
+1 -1
View File
@@ -24,7 +24,7 @@
# useful, but it comes WITHOUT ANY WARRANTY OR LIABILITY. #
# #
# Visit our website for the full manual and a complete tutorial about #
# how to conduct AMR data analysis: https://amr-for-r.org/ #
# how to conduct AMR data analysis: https://amr-for-r.org #
# ==================================================================== #
#' Data Sets with `r format(nrow(antimicrobials) + nrow(antivirals), big.mark = " ")` Antimicrobial Drugs
+1 -1
View File
@@ -24,7 +24,7 @@
# useful, but it comes WITHOUT ANY WARRANTY OR LIABILITY. #
# #
# Visit our website for the full manual and a complete tutorial about #
# how to conduct AMR data analysis: https://amr-for-r.org/ #
# how to conduct AMR data analysis: https://amr-for-r.org #
# ==================================================================== #
#' Transform Input to Disk Diffusion Diameters
+2 -2
View File
@@ -24,7 +24,7 @@
# useful, but it comes WITHOUT ANY WARRANTY OR LIABILITY. #
# #
# Visit our website for the full manual and a complete tutorial about #
# how to conduct AMR data analysis: https://amr-for-r.org/ #
# how to conduct AMR data analysis: https://amr-for-r.org #
# ==================================================================== #
# ====================================================== #
@@ -219,7 +219,7 @@ eucast_rules <- function(x,
if (interactive() && isTRUE(verbose) && isTRUE(info)) {
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.",
"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 comprehensive 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?"
)
+1 -1
View File
@@ -24,7 +24,7 @@
# useful, but it comes WITHOUT ANY WARRANTY OR LIABILITY. #
# #
# Visit our website for the full manual and a complete tutorial about #
# how to conduct AMR data analysis: https://amr-for-r.org/ #
# how to conduct AMR data analysis: https://amr-for-r.org #
# ==================================================================== #
#' Export Data Set as NCBI BioSample Antibiogram
+1 -1
View File
@@ -24,7 +24,7 @@
# useful, but it comes WITHOUT ANY WARRANTY OR LIABILITY. #
# #
# Visit our website for the full manual and a complete tutorial about #
# how to conduct AMR data analysis: https://amr-for-r.org/ #
# how to conduct AMR data analysis: https://amr-for-r.org #
# ==================================================================== #
#' Determine First Isolates
+1 -1
View File
@@ -24,7 +24,7 @@
# useful, but it comes WITHOUT ANY WARRANTY OR LIABILITY. #
# #
# Visit our website for the full manual and a complete tutorial about #
# how to conduct AMR data analysis: https://amr-for-r.org/ #
# how to conduct AMR data analysis: https://amr-for-r.org #
# ==================================================================== #
#' *G*-test for Count Data
+1 -1
View File
@@ -24,7 +24,7 @@
# useful, but it comes WITHOUT ANY WARRANTY OR LIABILITY. #
# #
# Visit our website for the full manual and a complete tutorial about #
# how to conduct AMR data analysis: https://amr-for-r.org/ #
# how to conduct AMR data analysis: https://amr-for-r.org #
# ==================================================================== #
#' Determine Clinical or Epidemic Episodes
+1 -1
View File
@@ -24,7 +24,7 @@
# useful, but it comes WITHOUT ANY WARRANTY OR LIABILITY. #
# #
# Visit our website for the full manual and a complete tutorial about #
# how to conduct AMR data analysis: https://amr-for-r.org/ #
# how to conduct AMR data analysis: https://amr-for-r.org #
# ==================================================================== #
#' PCA Biplot with `ggplot2`
+1 -1
View File
@@ -24,7 +24,7 @@
# useful, but it comes WITHOUT ANY WARRANTY OR LIABILITY. #
# #
# Visit our website for the full manual and a complete tutorial about #
# how to conduct AMR data analysis: https://amr-for-r.org/ #
# how to conduct AMR data analysis: https://amr-for-r.org #
# ==================================================================== #
#' AMR Plots with `ggplot2`
+1 -1
View File
@@ -24,7 +24,7 @@
# useful, but it comes WITHOUT ANY WARRANTY OR LIABILITY. #
# #
# Visit our website for the full manual and a complete tutorial about #
# how to conduct AMR data analysis: https://amr-for-r.org/ #
# how to conduct AMR data analysis: https://amr-for-r.org #
# ==================================================================== #
#' Guess Antibiotic Column
+1 -1
View File
@@ -24,7 +24,7 @@
# useful, but it comes WITHOUT ANY WARRANTY OR LIABILITY. #
# #
# Visit our website for the full manual and a complete tutorial about #
# how to conduct AMR data analysis: https://amr-for-r.org/ #
# how to conduct AMR data analysis: https://amr-for-r.org #
# ==================================================================== #
#' Italicise Taxonomic Families, Genera, Species, Subspecies
+1 -1
View File
@@ -24,7 +24,7 @@
# useful, but it comes WITHOUT ANY WARRANTY OR LIABILITY. #
# #
# Visit our website for the full manual and a complete tutorial about #
# how to conduct AMR data analysis: https://amr-for-r.org/ #
# how to conduct AMR data analysis: https://amr-for-r.org #
# ==================================================================== #
#' Join [microorganisms] to a Data Set
+1 -1
View File
@@ -24,7 +24,7 @@
# useful, but it comes WITHOUT ANY WARRANTY OR LIABILITY. #
# #
# Visit our website for the full manual and a complete tutorial about #
# how to conduct AMR data analysis: https://amr-for-r.org/ #
# how to conduct AMR data analysis: https://amr-for-r.org #
# ==================================================================== #
#' (Key) Antimicrobials for First Weighted Isolates
+1 -1
View File
@@ -24,7 +24,7 @@
# useful, but it comes WITHOUT ANY WARRANTY OR LIABILITY. #
# #
# Visit our website for the full manual and a complete tutorial about #
# how to conduct AMR data analysis: https://amr-for-r.org/ #
# how to conduct AMR data analysis: https://amr-for-r.org #
# ==================================================================== #
#' Kurtosis of the Sample
+1 -1
View File
@@ -24,7 +24,7 @@
# useful, but it comes WITHOUT ANY WARRANTY OR LIABILITY. #
# #
# Visit our website for the full manual and a complete tutorial about #
# how to conduct AMR data analysis: https://amr-for-r.org/ #
# how to conduct AMR data analysis: https://amr-for-r.org #
# ==================================================================== #
#' Vectorised Pattern Matching with Keyboard Shortcut
+1 -1
View File
@@ -24,7 +24,7 @@
# useful, but it comes WITHOUT ANY WARRANTY OR LIABILITY. #
# #
# Visit our website for the full manual and a complete tutorial about #
# how to conduct AMR data analysis: https://amr-for-r.org/ #
# how to conduct AMR data analysis: https://amr-for-r.org #
# ==================================================================== #
#' Determine Multidrug-Resistant Organisms (MDRO)
+1 -1
View File
@@ -24,7 +24,7 @@
# useful, but it comes WITHOUT ANY WARRANTY OR LIABILITY. #
# #
# Visit our website for the full manual and a complete tutorial about #
# how to conduct AMR data analysis: https://amr-for-r.org/ #
# how to conduct AMR data analysis: https://amr-for-r.org #
# ==================================================================== #
#' Calculate the Mean AMR Distance
+1 -1
View File
@@ -24,7 +24,7 @@
# useful, but it comes WITHOUT ANY WARRANTY OR LIABILITY. #
# #
# Visit our website for the full manual and a complete tutorial about #
# how to conduct AMR data analysis: https://amr-for-r.org/ #
# how to conduct AMR data analysis: https://amr-for-r.org #
# ==================================================================== #
# these are allowed MIC values and will become factor levels
+1 -1
View File
@@ -24,7 +24,7 @@
# useful, but it comes WITHOUT ANY WARRANTY OR LIABILITY. #
# #
# Visit our website for the full manual and a complete tutorial about #
# how to conduct AMR data analysis: https://amr-for-r.org/ #
# how to conduct AMR data analysis: https://amr-for-r.org #
# ==================================================================== #
#' Transform Arbitrary Input to Valid Microbial Taxonomy
+1 -1
View File
@@ -24,7 +24,7 @@
# useful, but it comes WITHOUT ANY WARRANTY OR LIABILITY. #
# #
# Visit our website for the full manual and a complete tutorial about #
# how to conduct AMR data analysis: https://amr-for-r.org/ #
# how to conduct AMR data analysis: https://amr-for-r.org #
# ==================================================================== #
#' Calculate the Matching Score for Microorganisms
+1 -1
View File
@@ -24,7 +24,7 @@
# useful, but it comes WITHOUT ANY WARRANTY OR LIABILITY. #
# #
# Visit our website for the full manual and a complete tutorial about #
# how to conduct AMR data analysis: https://amr-for-r.org/ #
# how to conduct AMR data analysis: https://amr-for-r.org #
# ==================================================================== #
#' Get Properties of a Microorganism
+1 -1
View File
@@ -24,7 +24,7 @@
# useful, but it comes WITHOUT ANY WARRANTY OR LIABILITY. #
# #
# Visit our website for the full manual and a complete tutorial about #
# how to conduct AMR data analysis: https://amr-for-r.org/ #
# how to conduct AMR data analysis: https://amr-for-r.org #
# ==================================================================== #
#' User-Defined Reference Data Set for Microorganisms
+1 -1
View File
@@ -24,7 +24,7 @@
# useful, but it comes WITHOUT ANY WARRANTY OR LIABILITY. #
# #
# Visit our website for the full manual and a complete tutorial about #
# how to conduct AMR data analysis: https://amr-for-r.org/ #
# how to conduct AMR data analysis: https://amr-for-r.org #
# ==================================================================== #
#' Principal Component Analysis (for AMR)
+1 -1
View File
@@ -24,7 +24,7 @@
# useful, but it comes WITHOUT ANY WARRANTY OR LIABILITY. #
# #
# Visit our website for the full manual and a complete tutorial about #
# how to conduct AMR data analysis: https://amr-for-r.org/ #
# how to conduct AMR data analysis: https://amr-for-r.org #
# ==================================================================== #
#' Plotting Helpers for AMR Data Analysis
+1 -1
View File
@@ -24,7 +24,7 @@
# useful, but it comes WITHOUT ANY WARRANTY OR LIABILITY. #
# #
# Visit our website for the full manual and a complete tutorial about #
# how to conduct AMR data analysis: https://amr-for-r.org/ #
# how to conduct AMR data analysis: https://amr-for-r.org #
# ==================================================================== #
#' Calculate Antimicrobial Resistance
+1 -1
View File
@@ -24,7 +24,7 @@
# useful, but it comes WITHOUT ANY WARRANTY OR LIABILITY. #
# #
# Visit our website for the full manual and a complete tutorial about #
# how to conduct AMR data analysis: https://amr-for-r.org/ #
# how to conduct AMR data analysis: https://amr-for-r.org #
# ==================================================================== #
#' Random MIC Values/Disk Zones/SIR Generation
+1 -1
View File
@@ -24,7 +24,7 @@
# useful, but it comes WITHOUT ANY WARRANTY OR LIABILITY. #
# #
# Visit our website for the full manual and a complete tutorial about #
# how to conduct AMR data analysis: https://amr-for-r.org/ #
# how to conduct AMR data analysis: https://amr-for-r.org #
# ==================================================================== #
#' Predict Antimicrobial Resistance
+1 -1
View File
@@ -24,7 +24,7 @@
# useful, but it comes WITHOUT ANY WARRANTY OR LIABILITY. #
# #
# Visit our website for the full manual and a complete tutorial about #
# how to conduct AMR data analysis: https://amr-for-r.org/ #
# how to conduct AMR data analysis: https://amr-for-r.org #
# ==================================================================== #
#' Interpret MIC and Disk Diffusion as SIR, or Clean Existing SIR Data
+2 -2
View File
@@ -24,7 +24,7 @@
# useful, but it comes WITHOUT ANY WARRANTY OR LIABILITY. #
# #
# Visit our website for the full manual and a complete tutorial about #
# how to conduct AMR data analysis: https://amr-for-r.org/ #
# how to conduct AMR data analysis: https://amr-for-r.org #
# ==================================================================== #
dots2vars <- function(...) {
@@ -217,7 +217,7 @@ sir_calc <- function(...,
}
if (as_percent == TRUE) {
percentage(fraction, digits = 1)
trimws(percentage(fraction, digits = 1))
} else {
fraction
}
+1 -1
View File
@@ -24,7 +24,7 @@
# useful, but it comes WITHOUT ANY WARRANTY OR LIABILITY. #
# #
# Visit our website for the full manual and a complete tutorial about #
# how to conduct AMR data analysis: https://amr-for-r.org/ #
# how to conduct AMR data analysis: https://amr-for-r.org #
# ==================================================================== #
#' @rdname proportion
+1 -1
View File
@@ -24,7 +24,7 @@
# useful, but it comes WITHOUT ANY WARRANTY OR LIABILITY. #
# #
# Visit our website for the full manual and a complete tutorial about #
# how to conduct AMR data analysis: https://amr-for-r.org/ #
# how to conduct AMR data analysis: https://amr-for-r.org #
# ==================================================================== #
#' Skewness of the Sample
+1 -1
View File
@@ -24,7 +24,7 @@
# useful, but it comes WITHOUT ANY WARRANTY OR LIABILITY. #
# #
# Visit our website for the full manual and a complete tutorial about #
# how to conduct AMR data analysis: https://amr-for-r.org/ #
# how to conduct AMR data analysis: https://amr-for-r.org #
# ==================================================================== #
#' Filter Top *n* Microorganisms
+1 -1
View File
@@ -24,7 +24,7 @@
# useful, but it comes WITHOUT ANY WARRANTY OR LIABILITY. #
# #
# Visit our website for the full manual and a complete tutorial about #
# how to conduct AMR data analysis: https://amr-for-r.org/ #
# how to conduct AMR data analysis: https://amr-for-r.org #
# ==================================================================== #
#' Translate Strings from the AMR Package
+1 -1
View File
@@ -24,7 +24,7 @@
# useful, but it comes WITHOUT ANY WARRANTY OR LIABILITY. #
# #
# Visit our website for the full manual and a complete tutorial about #
# how to conduct AMR data analysis: https://amr-for-r.org/ #
# how to conduct AMR data analysis: https://amr-for-r.org #
# ==================================================================== #
# These are all S3 implementations for the vctrs package,
+1 -1
View File
@@ -24,7 +24,7 @@
# useful, but it comes WITHOUT ANY WARRANTY OR LIABILITY. #
# #
# Visit our website for the full manual and a complete tutorial about #
# how to conduct AMR data analysis: https://amr-for-r.org/ #
# how to conduct AMR data analysis: https://amr-for-r.org #
# ==================================================================== #
#' WHOCC: WHO Collaborating Centre for Drug Statistics Methodology
+1 -1
View File
@@ -24,7 +24,7 @@
# useful, but it comes WITHOUT ANY WARRANTY OR LIABILITY. #
# #
# Visit our website for the full manual and a complete tutorial about #
# how to conduct AMR data analysis: https://amr-for-r.org/ #
# how to conduct AMR data analysis: https://amr-for-r.org #
# ==================================================================== #
#' Deprecated Functions
+1 -1
View File
@@ -24,7 +24,7 @@
# useful, but it comes WITHOUT ANY WARRANTY OR LIABILITY. #
# #
# Visit our website for the full manual and a complete tutorial about #
# how to conduct AMR data analysis: https://amr-for-r.org/ #
# how to conduct AMR data analysis: https://amr-for-r.org #
# ==================================================================== #
# set up package environment, used by numerous AMR functions