report.on.demographics: Print a demographics report

Description Usage Arguments Value See Also

View source: R/metadata_io.R

Description

Print a demographics report

Usage

1
2
3
4
5
report.on.demographics(
  demographics_df,
  group_column_name = NULL,
  paired = FALSE
)

Arguments

demographics_df

a demographics data.frame, as returned by read.md.demographics.

group_column_name,

string or NULL. If given, the column name of the group column. It must be a factor column with 2 levels. Enables group-comparison tests. Defaults to 'NULL'.

paired

Whether the data of the two groups if paired (repeated measurements). Only relevant if group_column_name is given and tests for group differences are included in the report. Defaults to 'FALSE'.

Value

vector of character strings, the lines of the demographics report.

See Also

Other metadata functions: demographics.to.fsgd.file(), read.md.demographics(), read.md.subjects()


fsbrain documentation built on Sept. 16, 2021, 5:07 p.m.