Report General Features

report(
  data,
  vars,
  med = FALSE,
  cent = TRUE,
  disp = TRUE,
  ran = TRUE,
  distr = FALSE,
  lev = FALSE,
  n_ch = 3,
  mis = FALSE
)

Arguments

data

the data as a data frame

vars

string naming the variables from data that contains the values used for the report. Uses report::report() function. Refer to report.data.frame report documentation.

med

Boolean argument whether to include 'median' instead of 'mean'. Default is false.

cent

Boolean argument whether to include centrality (mean or median). Default is true.

disp

Boolean argument whether to include dispersion. Default is true.

ran

Boolean argument whether to include centrality (mean or median). Default is true.

distr

Boolean argument whether to include kurtosis and skewness. Default is false.

lev

Boolean argument whether to use percentage instead of numbers. Default is false.

n_ch

Boolean argument whether to use percentage instead of numbers. Default is false.

mis

Boolean argument whether to include missing as percentage. Default is false.

Value

A results object containing:

results$todoa html
results$texta preformatted