mirror of
https://github.com/msberends/AMR.git
synced 2024-12-26 20:06:11 +01:00
71 lines
3.3 KiB
R
Executable File
71 lines
3.3 KiB
R
Executable File
# ==================================================================== #
|
|
# TITLE: #
|
|
# AMR: An R Package for Working with Antimicrobial Resistance Data #
|
|
# #
|
|
# SOURCE CODE: #
|
|
# https://github.com/msberends/AMR #
|
|
# #
|
|
# PLEASE CITE THIS SOFTWARE AS: #
|
|
# Berends MS, Luz CF, Friedrich AW, et al. (2022). #
|
|
# AMR: An R Package for Working with Antimicrobial Resistance Data. #
|
|
# Journal of Statistical Software, 104(3), 1-31. #
|
|
# https://doi.org/10.18637/jss.v104.i03 #
|
|
# #
|
|
# Developed at the University of Groningen and the University Medical #
|
|
# Center Groningen in The Netherlands, in collaboration with many #
|
|
# colleagues from around the world, see our website. #
|
|
# #
|
|
# 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. #
|
|
# We created this package for both routine data analysis and academic #
|
|
# research and it was publicly released in the hope that it will be #
|
|
# 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://msberends.github.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).
|
|
# #' @keywords internal
|
|
# #' @name AMR-deprecated
|
|
# #' @rdname AMR-deprecated
|
|
# #' @export
|
|
# NULL
|
|
|
|
deprecation_warning <- function(old = NULL, new = NULL, extra_msg = NULL, is_function = TRUE) {
|
|
if (is.null(old)) {
|
|
warning_(extra_msg)
|
|
} else {
|
|
env <- paste0("deprecated_", old)
|
|
if (!env %in% names(AMR_env)) {
|
|
AMR_env[[paste0("deprecated_", old)]] <- 1
|
|
if (isTRUE(is_function)) {
|
|
old <- paste0(old, "()")
|
|
new <- paste0(new, "()")
|
|
type <- "function"
|
|
} else {
|
|
type <- "argument"
|
|
}
|
|
warning_(
|
|
ifelse(is.null(new),
|
|
paste0("The `", old, "` ", type, " is no longer in use"),
|
|
paste0("The `", old, "` ", type, " has been replaced with `", new, "`")
|
|
),
|
|
ifelse(type == "argument",
|
|
". While the old argument still works, it will be removed in a future version, so please update your code.",
|
|
", see `?AMR-deprecated`."
|
|
),
|
|
ifelse(!is.null(extra_msg),
|
|
paste0(" ", extra_msg),
|
|
""
|
|
),
|
|
"\nThis warning will be shown once per session."
|
|
)
|
|
}
|
|
}
|
|
}
|