explore: Explorative data analysis of data frame variables.

View source: R/functions_exploration.R

exploreR Documentation

Explorative data analysis of data frame variables.

Description

Performs exploratory data analysis for the selected variables of a data frame. The output may include lists of distribution statistics, a publication-ready table with the distribution statistics or distribution plots.

Usage

explore(
  data,
  split_factor = NULL,
  variables = names(data),
  what = c("list", "table", "plots", "raw", "normality", "skewness", "kurtosis"),
  pub_styled = TRUE,
  signif_digits = 2,
  simplify_p = TRUE,
  ...
)

Arguments

data

a data frame.

split_factor

optional, the name of a factor used for splitting the variables of interest into analysis groups.

variables

a vector of variable names.

what

the type of output: 'list' returns a list of distribution statistics, 'table' returns a publication-ready table with the distribution stats, 'plots' returns a list of plots, 'raw' returns a list of EDA objects (eda), 'normality' returns a table with results of Shapiro-Wilk test, 'skewness' and 'kurtosis' return tables with the requested statistics.

pub_styled

logical, should the output be publication-ready formatted?

signif_digits

significant digits used for rounding in the publication-style output.

simplify_p

logical, should p_values < 0.001 be presented in a p < 0.001 form?

...

additional arguments passed to summary.eda or plot.eda.

Value

as specified by the 'what' argument: a list of stats, a statistic table or a list of plots.


PiotrTymoszuk/ExDA documentation built on Nov. 17, 2024, 5:46 p.m.