R/Q.R

Defines functions Q

Documented in Q

#' @title wskazany kwantyl
#' @description
#' Istnieje możliwość obliczenia wartości wielu kwantyli jednocześnie - 
#' wystarczy jako q przekazać wektor. W takim wypadku zwrócony zostanie wektor
#' odpowiednich kwantyli.
#' @param x wektor wartości
#' @param q numer kwantyla (może być wektorem)
#' @param n liczba kwantyli
#' @param wyrownaj czy wyrównywać długość wyniku (jeśli NA, wybór zostanie
#'   dokonany automatycznie)
#' @param dokl liczba cyfr po przecinku, do których zaokrąglony zostanie wynik
#' @return NULL
#' @export
Q = function(x, q, n, wyrownaj = NA, dokl = 2){
  stopifnot(
    is.numeric(x),
    is.numeric(q),
    is.numeric(n),
    length(n) == 1,
    all(n >= q),
    n >= 1
  )
  wyrownaj = ustawWyrownaj(wyrownaj)
  
  f = function(x){
    tmp = stats::quantile(x, seq(0, 1, length.out = n + 1), na.rm = TRUE)
    return(tmp[q + 1])
  }
  return(statWektor(x, f, sys.call(), wyrownaj, dokl))
}
zozlak/MLAK documentation built on July 16, 2020, 10 p.m.