plot_density: Plot distribution and results of statistical tests

View source: R/plot-statistics-single.R

plot_densityR Documentation

Plot distribution and results of statistical tests

Description

These functions visualize the distribution of numerical variables via histograms, density- and ridgeplots. Argument variables accepts only values that refer to numerical variables.

Usage

plot_density(
  df,
  variables = NULL,
  across = NULL,
  across.subset = NULL,
  relevel = TRUE,
  display.facets = TRUE,
  scales = "free",
  nrow = NULL,
  ncol = NULL,
  clrp = "milo",
  clrp.adjust = NULL,
  verbose = TRUE,
  ...
)

plot_histogram(
  df,
  variables = NULL,
  across = NULL,
  across.subset = NULL,
  relevel = TRUE,
  scales = "free",
  nrow = NULL,
  ncol = NULL,
  clrp = "milo",
  clrp.adjust = NULL,
  verbose = TRUE,
  ...
)

plot_ridgeplot(
  df,
  variables = NULL,
  across = NULL,
  across.subset = NULL,
  relevel = TRUE,
  display.facets = TRUE,
  scales = "free",
  nrow = NULL,
  ncol = NULL,
  alpha = 0.85,
  clrp = "milo",
  clrp.adjust = NULL,
  verbose = TRUE,
  ...
)

Arguments

df

A data.frame.

variables

Character vector. Specifies the variables of interest. If set to NULL all valid variables of the input data.frame are considered (as long as the total number does not exceeds the limit).

If there are more variables you are interested in than they are variables you are not interested in specify those that you are not interested in prefixed with an '-'. Variables prefixed that way are discarded and the remaining are kept.

across

Character value. Specifies the discrete variable in the data.frame across which the variables of interest are to be analyzed or displayed.

across.subset

Character vector. The groups of interest that the grouping variable denoted in across contains.

If there are more groups you are interested in than they are groups you are not interested in specify those that you are not interested in prefixed with an '-'. Variables prefixed that way are discarded and the remaining are kept.

relevel

Logical value. If set to TRUE the input order of across.subset and variables determines the order in which the groups of interest are displayed.

display.facets

Logical value. Only relevant if across is set to NULL. Denotes if a subplot for each variable is supposed to be created.

scales, nrow, ncol

Given to ggplot2::facet_wrap(). Affects the way the subplots are displayed.

clrp

Character value. Specifies the color palette to be used to represent groups of discrete variables. Run validColorPalettes() to obtain valid input options.

clrp.adjust

Named character vector or NULL. If character, it adjusts the colors that are used to represent the groups. Names of the input vector must refer to the group and the respective named element denotes the color with which to represent the group.

verbose

Logical. If set to TRUE informative messages regarding the computational progress will be printed.

(Warning messages will always be printed.)

...

Additional arguments given to the respective ggplot2::geom_<plot_type>() function.

Value

Returns a ggplot-object that can be additionally customized according to the rules of the ggplot2-framework.


kueckelj/confuns documentation built on July 4, 2024, 4:53 p.m.