volker (version 3.0.0)

.report_cls: Generate an cluster table and plot

Description

Generate an cluster table and plot

Usage

.report_cls(
  data,
  cols,
  cross,
  metric = FALSE,
  ...,
  k = 2,
  effect = FALSE,
  title = TRUE
)

Value

A list containing a table and a plot volker report chunk.

Arguments

data

A data frame.

cols

A tidy column selection, e.g. a single column (without quotes) or multiple columns selected by methods such as starts_with().

cross

Not yet implemented. Optional, a grouping column (without quotes).

metric

Not yet implemented. When crossing variables, the cross column parameter can contain categorical or metric values. By default, the cross column selection is treated as categorical data. Set metric to TRUE, to treat it as metric and calculate correlations.

k

Number of clusters to calculate.

effect

Not yet implemented. Whether to report statistical tests and effect sizes.

title

Add a plot title (default = TRUE).