R/descriptive.R

In leminhthien2011/CONETTravel: What the Package Does is (Title Case)

#' This function gives descriptive statistic of a numeric vector.
#' @param x numeric vector
#' @import tibble
#' @importFrom stats median quantile sd
#' @examples
#' x = 1:9
#' descriptive(x)
#' \dontrun{A tibble: 1 x 9
#' len  mean    sd   min   max   med firstpt thirdpt   IQR
#' <int> <dbl> <dbl> <int> <int> <int>   <dbl>   <dbl> <dbl>
#'  9     5  2.74     1     9     5       3       7     4
#'  }
#' @export
descriptive <- function(x){
  tibble(len = length(x),
         mean = mean(x),
         sd = sd(x),
         min = min(x),
         max = max(x),
         med = median(x),
         firstpt = quantile(x,.25),
         thirdpt = quantile(x, .75),
         IQR = thirdpt - firstpt)

}