Describe a participant register

sdt_describe() with the defaults a sdt_participants register wants: split by course, and reporting the normalised covariates rather than the raw German free text they were derived from.

Usage

sdt_describe_participants(x, by = "short_course_id", ...)

Arguments

x

A sdt_participants object from sdt_read_participants().

by

Column to split by. Defaults to "short_course_id"; NULL pools the whole register.

...

Passed to sdt_describe(), including vars, na_report and digits.

Value

A sdt_describe object.

Details

Courses with no linked participants have no rows in the register, so they cannot appear as groups. They are named in the printed header instead, read from the course_index attribute, so their absence is stated rather than left for the reader to notice.

See also

sdt_describe(), sdt_read_participants().

Examples

if (FALSE) { # \dontrun{
p <- sdt_read_participants("TDSC_course_participant_relations.xlsx")
sdt_describe_participants(p)
sdt_describe_participants(p, by = NULL, na_report = "footnote")
} # }