AMR/R/skewness.R

71 lines
3.4 KiB
R
Raw Normal View History

# ==================================================================== #
# TITLE #
# Antimicrobial Resistance (AMR) Data Analysis for R #
# #
2019-01-02 23:24:07 +01:00
# SOURCE #
2020-07-08 14:48:06 +02:00
# https://github.com/msberends/AMR #
# #
# LICENCE #
2021-12-23 18:56:28 +01:00
# (c) 2018-2022 Berends MS, Luz CF et al. #
2020-10-08 11:16:03 +02:00
# Developed at the University of Groningen, the Netherlands, in #
# collaboration with non-profit organisations Certe Medical #
# Diagnostics & Advice, and University Medical Center Groningen. #
# #
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. #
# 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. #
2020-10-08 11:16:03 +02:00
# #
# Visit our website for the full manual and a complete tutorial about #
# how to conduct AMR data analysis: https://msberends.github.io/AMR/ #
# ==================================================================== #
#' Skewness of the Sample
2018-07-08 22:14:55 +02:00
#'
#' @description Skewness is a measure of the asymmetry of the probability distribution of a real-valued random variable about its mean.
#'
#' When negative ('left-skewed'): the left tail is longer; the mass of the distribution is concentrated on the right of a histogram. When positive ('right-skewed'): the right tail is longer; the mass of the distribution is concentrated on the left of a histogram. A normal distribution has a skewness of 0.
#' @inheritSection lifecycle Stable Lifecycle
2020-10-08 11:16:03 +02:00
#' @param x a vector of values, a [matrix] or a [data.frame]
2021-05-12 18:15:03 +02:00
#' @param na.rm a [logical] value indicating whether `NA` values should be stripped before the computation proceeds
#' @seealso [kurtosis()]
2018-07-08 22:14:55 +02:00
#' @rdname skewness
#' @inheritSection AMR Read more on Our Website!
2018-07-08 22:14:55 +02:00
#' @export
skewness <- function(x, na.rm = FALSE) {
meet_criteria(na.rm, allow_class = "logical", has_length = 1)
2018-07-08 22:14:55 +02:00
UseMethod("skewness")
}
2020-05-28 16:48:55 +02:00
#' @method skewness default
2018-07-08 22:14:55 +02:00
#' @rdname skewness
#' @export
2019-10-11 17:21:02 +02:00
skewness.default <- function(x, na.rm = FALSE) {
meet_criteria(na.rm, allow_class = "logical", has_length = 1)
2018-07-08 22:14:55 +02:00
x <- as.vector(x)
if (na.rm == TRUE) {
x <- x[!is.na(x)]
}
n <- length(x)
(sum((x - mean(x))^3) / n) / (sum((x - mean(x)) ^ 2) / n) ^ (3 / 2)
2018-07-08 22:14:55 +02:00
}
2020-05-28 16:48:55 +02:00
#' @method skewness matrix
2018-07-08 22:14:55 +02:00
#' @rdname skewness
#' @export
2019-10-11 17:21:02 +02:00
skewness.matrix <- function(x, na.rm = FALSE) {
meet_criteria(na.rm, allow_class = "logical", has_length = 1)
apply(x, 2, skewness.default, na.rm = na.rm)
2018-07-08 22:14:55 +02:00
}
2020-05-28 16:48:55 +02:00
#' @method skewness data.frame
2018-07-08 22:14:55 +02:00
#' @rdname skewness
#' @export
2019-10-11 17:21:02 +02:00
skewness.data.frame <- function(x, na.rm = FALSE) {
meet_criteria(na.rm, allow_class = "logical", has_length = 1)
vapply(FUN.VALUE = double(1), x, skewness.default, na.rm = na.rm)
2018-07-08 22:14:55 +02:00
}