Skip to contents

Configure a clintable to table by a grouping variable, which will be used as a label

Source: R/pagination.R
clin_group_by.Rd

Configure a clintable to table by a grouping variable, which will be used as a label

Usage

clin_group_by(x, group_by, caption_by = NULL)

Arguments

x

A clintable object

group_by

A character vector of variable names which will be used for grouping and attached as a label above the table headers

caption_by

A single element string of a variable name which will be used as a caption attached below the table body and above in the footer. Defaults to NULL.

Value

A clintable object

Examples

clintable(iris) |>
  clin_group_by("Species")


  
setosa
Sepal.Length
Sepal.Width
Petal.Length
Petal.Width
5.1
3.5
1.4
0.2