dtsmartr_options: Generate Configuration Options for dtsmartr

View source: R/dtsmartr.R

dtsmartr_optionsR Documentation

Generate Configuration Options for dtsmartr

Description

Helper function to specify UI customization, initial grid visibility states, and rendering options for the dtsmartr interactive grid widget.

Usage

dtsmartr_options(
  advanced_filter = TRUE,
  show_labels = TRUE,
  column_picker = TRUE,
  allow_export = TRUE,
  theme = "auto",
  na_string = "NA",
  hidden_columns = NULL,
  header_summary = TRUE,
  header_density = "auto",
  row_density = "standard"
)

Arguments

advanced_filter

Logical. If TRUE (default), renders the multi-condition Advanced Query Builder panel.

show_labels

Logical. If TRUE (default), displays R column attributes (like 'label') in table headers.

column_picker

Logical. If TRUE (default), displays the top-right column show/hide visibility dropdown.

allow_export

Logical. If TRUE (default), displays clipboard copy buttons and the R & SQL "Query Code" generator modal.

theme

Character. Specifies the UI color theme: "auto" (default, inherits from browser settings), "light", or "dark".

na_string

Character. Custom string placeholder displayed in cells with missing values (NA or null). Defaults to "NA".

hidden_columns

Character vector. Vector of column names to hide by default on initial widget rendering.

header_summary

Logical. If TRUE (default), renders the Kaggle-style summary zone (histograms, bar charts, completeness bar) in column headers.

header_density

Character. Density mode for column headers: "auto" (default), "minimal", or "detailed".

row_density

Character. Density mode for rows: "standard" (default), "compact", or "comfortable".

Value

A named list of validated configuration settings.

Examples

dtsmartr_options(advanced_filter = FALSE, hidden_columns = c("STUDYID", "USUBJID"))
dtsmartr_options(header_summary = FALSE)
dtsmartr_options(header_density = "minimal", row_density = "compact")

dtsmartr documentation built on July 16, 2026, 5:08 p.m.