Understand a dataset before analysis — describe

Create a concise, clinically oriented first look at a dataset. One row is returned per variable, combining its label, detected type, completeness, cardinality, a type-specific overview, and range or levels. Potential data-quality findings are kept separately in $issues.

Usage

describe_data(data, vars = NULL, digits = 2, format = c("table", "tibble"))

Arguments

data: A data.frame.
vars: Optional character vector of variables. Default is all variables.
digits: Number of decimal places in concise numeric summaries.
format: Output format: "table" (default) or "tibble".

Value

With format = "table", a gt_describe object that prints as a publication-ready table. $summary is the concise variable overview and $issues contains only findings requiring review. With format = "tibble", the concise summary tibble is returned directly.

Details

describe_data() deliberately does not assess distributional assumptions or recommend inferential tests. Use assess_distribution() for the shape of selected continuous variables, summary_table() for detailed descriptive statistics, and compare_groups() for inferential comparisons.

Examples

describe_data(mtcars)
describe_data(mtcars, vars = c("mpg", "cyl", "am"))
to_gt(describe_data(mtcars))


  Variable
      Type
      Complete
      Unique
      Overview
      Range / levels
    
mpg
continuous
32/32 (100.0%)
25
Mean 20.09 (SD 6.03); median 19.20
10.40 to 33.90
cyl
categorical
32/32 (100.0%)
3
8 14 (43.8%); 4 11 (34.4%); 6 7 (21.9%)
6, 4, 8
disp
continuous
32/32 (100.0%)
27
Mean 230.72 (SD 123.94); median 196.30
71.10 to 472.00
hp
continuous
32/32 (100.0%)
22
Mean 146.69 (SD 68.56); median 123.00
52.00 to 335.00
drat
continuous
32/32 (100.0%)
22
Mean 3.60 (SD 0.53); median 3.70
2.76 to 4.93
wt
continuous
32/32 (100.0%)
29
Mean 3.22 (SD 0.98); median 3.33
1.51 to 5.42
qsec
continuous
32/32 (100.0%)
30
Mean 17.85 (SD 1.79); median 17.71
14.50 to 22.90
vs
binary
32/32 (100.0%)
2
0 18 (56.2%); 1 14 (43.8%)
0, 1
am
binary
32/32 (100.0%)
2
0 19 (59.4%); 1 13 (40.6%)
1, 0
gear
categorical*
32/32 (100.0%)
3
3 15 (46.9%); 4 12 (37.5%); 5 5 (15.6%)
4, 3, 5
carb
continuous
32/32 (100.0%)
6
Mean 2.81 (SD 1.62); median 2.00
1.00 to 8.00
* Possible ordinal or count-coded variable. Confirm the intended meaning and order using the data dictionary or clinical context.

Variable	Type	Complete	Unique	Overview	Range / levels
mpg	continuous	32/32 (100.0%)	25	Mean 20.09 (SD 6.03); median 19.20	10.40 to 33.90
cyl	categorical	32/32 (100.0%)	3	8 14 (43.8%); 4 11 (34.4%); 6 7 (21.9%)	6, 4, 8
disp	continuous	32/32 (100.0%)	27	Mean 230.72 (SD 123.94); median 196.30	71.10 to 472.00
hp	continuous	32/32 (100.0%)	22	Mean 146.69 (SD 68.56); median 123.00	52.00 to 335.00
drat	continuous	32/32 (100.0%)	22	Mean 3.60 (SD 0.53); median 3.70	2.76 to 4.93
wt	continuous	32/32 (100.0%)	29	Mean 3.22 (SD 0.98); median 3.33	1.51 to 5.42
qsec	continuous	32/32 (100.0%)	30	Mean 17.85 (SD 1.79); median 17.71	14.50 to 22.90
vs	binary	32/32 (100.0%)	2	0 18 (56.2%); 1 14 (43.8%)	0, 1
am	binary	32/32 (100.0%)	2	0 19 (59.4%); 1 13 (40.6%)	1, 0
gear	categorical*	32/32 (100.0%)	3	3 15 (46.9%); 4 12 (37.5%); 5 5 (15.6%)	4, 3, 5
carb	continuous	32/32 (100.0%)	6	Mean 2.81 (SD 1.62); median 2.00	1.00 to 8.00
* Possible ordinal or count-coded variable. Confirm the intended meaning and order using the data dictionary or clinical context.