compare: Compare or correlate features between collectives/cohorts.

View source: R/functions_exploration.R

compareR Documentation

Compare or correlate features between collectives/cohorts.

Description

Compares the given variable between the provided data sets with a range of statistical sets as described for test (statistical testing), distribution (distribution comparison), variance (variance comparison), correlate (correlation) or covariance (covariance).

Usage

compare(
  ...,
  variable,
  split_factor = NULL,
  what = c("test", "distribution", "variance", "correlation", "covariance", "eff_size"),
  type = "t_test",
  exact = TRUE,
  ci = TRUE,
  boot_method = "percentile",
  pub_styled = FALSE,
  signif_digits = 2
)

Arguments

...

data frames.

variable

a variable name.

split_factor

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

what

the requested analysis: 'test', 'distribution', 'variance', 'correlation', 'covariance' or 'eff_size'. Defaults to 'test'.

type

type of statistical test, see test, correlate, covariance or eff_size for details.

exact

logical, should exact values for Chi-squared, Mann-Whitney and Wilcoxon test be returned?

ci

logical, should confidence intervals for the test effect size be returned?

boot_method

indicates how the bootstrap confidence intervals are calculated. Can be any of 'percentile', 'bca', or 'normality', defaults to 'percentile'.

pub_styled

logical, should the output be publication-ready formatted?

signif_digits

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

Details

in case, the split_factor is provided, only the first of the input data frames will be analyzed.


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