AMR/R/p_symbol.R

43 lines
2.0 KiB
R
Raw Normal View History

2018-07-01 21:40:37 +02:00
# ==================================================================== #
# TITLE #
# Antimicrobial Resistance (AMR) Analysis #
# #
2019-01-02 23:24:07 +01:00
# SOURCE #
# https://gitlab.com/msberends/AMR #
2018-07-01 21:40:37 +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-07-01 21:40:37 +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-07-01 21:40:37 +02:00
# ==================================================================== #
#' 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 \code{p = 1} will return \code{NA}.
2018-07-01 21:40:37 +02:00
#' @param p p value
#' @param emptychar text to show when \code{p > 0.1}
#' @return Text
2019-01-02 23:24:07 +01:00
#' @inheritSection AMR Read more on our website!
2018-07-01 21:40:37 +02:00
#' @export
2019-09-03 09:47:39 +02:00
p_symbol <- function(p, emptychar = " ") {
2018-07-01 21:40:37 +02:00
2019-09-03 09:47:39 +02:00
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] <- "***"
2018-07-01 21:40:37 +02:00
s
}