AMR/R/deprecated.R

98 lines
3.3 KiB
R
Raw Normal View History

2018-08-31 13:36:19 +02:00
# ==================================================================== #
# TITLE #
# Antimicrobial Resistance (AMR) Analysis #
# #
2019-01-02 23:24:07 +01:00
# SOURCE #
# https://gitlab.com/msberends/AMR #
2018-08-31 13:36:19 +02:00
# #
# LICENCE #
2019-01-02 23:24:07 +01:00
# (c) 2019 Berends MS (m.s.berends@umcg.nl), Luz CF (c.f.luz@umcg.nl) #
2018-08-31 13:36:19 +02:00
# #
2019-01-02 23:24:07 +01:00
# 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. #
2019-04-05 18:47:39 +02:00
# Visit our website for more info: https://msberends.gitlab.io/AMR. #
2018-08-31 13:36:19 +02:00
# ==================================================================== #
#' Deprecated functions
#'
2019-01-26 23:22:56 +01:00
#' These functions are so-called '\link{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).
2019-01-02 23:24:07 +01:00
#' @inheritSection AMR Read more on our website!
2018-08-31 13:36:19 +02:00
#' @export
#' @keywords internal
#' @name AMR-deprecated
#' @rdname AMR-deprecated
ratio <- function(x, ratio) {
.Deprecated(package = "AMR")
if (!all(is.numeric(x))) {
stop('`x` must be a vector of numeric values.')
}
if (length(ratio) == 1) {
if (ratio %like% '^([0-9]+([.][0-9]+)?[-,:])+[0-9]+([.][0-9]+)?$') {
# support for "1:2:1", "1-2-1", "1,2,1" and even "1.75:2:1.5"
2018-09-14 10:31:21 +02:00
ratio <- ratio %>% strsplit("[-,:]") %>% unlist() %>% as.double()
2018-08-31 13:36:19 +02:00
} else {
stop('Invalid `ratio`: ', ratio, '.')
}
}
2018-09-14 10:31:21 +02:00
if (length(x) != 1 & length(x) != length(ratio)) {
2018-08-31 13:36:19 +02:00
stop('`x` and `ratio` must be of same size.')
}
2018-09-14 10:31:21 +02:00
sum(x, na.rm = TRUE) * (ratio / sum(ratio, na.rm = TRUE))
2018-08-31 13:36:19 +02:00
}
2019-01-06 16:40:55 +01:00
2019-01-26 23:22:56 +01:00
#' @rdname AMR-deprecated
#' @export
2019-05-10 16:44:59 +02:00
abname <- function(...) {
.Deprecated("ab_name", package = "AMR")
ab_name(...)
2019-01-26 23:22:56 +01:00
}
#' @rdname AMR-deprecated
#' @export
2019-05-10 16:44:59 +02:00
atc_property <- function(...) {
.Deprecated("ab_property", package = "AMR")
ab_property(...)
2019-01-26 23:22:56 +01:00
}
#' @rdname AMR-deprecated
#' @export
2019-05-10 16:44:59 +02:00
atc_official <- function(...) {
.Deprecated("ab_name", package = "AMR")
ab_name(...)
2019-01-26 23:22:56 +01:00
}
#' @rdname AMR-deprecated
#' @export
2019-05-10 16:44:59 +02:00
ab_official <- function(...) {
.Deprecated("ab_name", package = "AMR")
ab_name(...)
2019-01-26 23:22:56 +01:00
}
#' @rdname AMR-deprecated
#' @export
2019-05-10 16:44:59 +02:00
atc_name <- function(...) {
.Deprecated("ab_name", package = "AMR")
ab_name(...)
2019-01-26 23:22:56 +01:00
}
2019-01-27 13:33:43 +01:00
#' @rdname AMR-deprecated
#' @export
2019-05-10 16:44:59 +02:00
atc_trivial_nl <- function(...) {
.Deprecated("ab_name", package = "AMR")
ab_name(..., language = "nl")
2019-01-27 13:33:43 +01:00
}
#' @rdname AMR-deprecated
#' @export
2019-05-10 16:44:59 +02:00
atc_tradenames <- function(...) {
.Deprecated("ab_tradenames", package = "AMR")
ab_tradenames(...)
2019-01-27 13:33:43 +01:00
}