Compute descriptive statistics

This function computes common descriptive statistics of numeric variables for grouped or ungrouped data and converts it to a tidy formatted table. This function tried to copy dlookr::describe() because of this issue.

describe(
  data,
  yvars,
  lang = c("eng", "ger")[1],
  ungroupafter = TRUE,
  digits = "round_smart",
  addstats = character(),
  ...
)

Arguments

data

A data.frame or a tbl_df or a grouped_df.

yvars

A character vector with the names of the columns to be described.

lang

Language for table names.

ungroupafter

If TRUE, the results will be ungroup()-ed.

digits

Number of digits all numeric columns are rounded to. The default is actually "round_smart" which applies BioMathR::round_smart() to each numeric column individually.

addstats

Character vector with additional statistics to be calculated besides the default. Possible entries: c("Skewness").

...

Other arguments passed to BioMathR::round_smart()

Value

A tibble

Examples

library(dplyr)
library(BioMathR)
PlantGrowth %>%
  group_by(group) %>%
  describe("weight")
#> # A tibble: 3 × 10
#>   Variable group     N  Miss  Mean StdDev   IQR   Min Median   Max
#>   <chr>    <fct> <dbl> <dbl> <dbl>  <dbl> <dbl> <dbl>  <dbl> <dbl>
#> 1 weight   ctrl     10     0  5.03    0.6   0.7   4.2    5.2  6.11
#> 2 weight   trt1     10     0  4.66    0.8   0.7   3.6    4.6  6.03
#> 3 weight   trt2     10     0  5.53    0.4   0.5   4.9    5.4  6.31

PlantGrowth %>%
  mutate(
    group2 = as.factor(rep(c("A", "A", "B",  "B", "B"), 6)),
    weight2 = weight * 2,
    weight3 = rep(c(3, NA), 15)
  ) %>%
  group_by(group, group2) %>%
  describe(c("weight", "weight2", "weight3"), lang = "ger") %>%
  docx_tab()