test.numerical.meandiff.unpaired: Perform tests for group differences on unpaired data for two...

View source: R/metadata_io.R

test.numerical.meandiff.unpairedR Documentation

Perform tests for group differences on unpaired data for two groups.

Description

This function is intended to give you a quick overview of your demographics data, it is in no way intended to replace a detailed analysis of your data. You should always visualize and analyze your data interactively instead of relying on automated methods like this. Outliers and are very common in real-world data while perfectly normal data is very rare, multiple testing may affect your results. Look at your data!

Usage

test.numerical.meandiff.unpaired(
  colname,
  group1_name,
  group2_name,
  group1_data_column,
  group2_data_column
)

Arguments

colname

string, the name of the data (used to label the data in the output)

group1_name

string, the name of the first group (used to label the data in the output)

group2_name

string, the name of the first group (used to label the data in the output)

group1_data_column

the data for group1 as a numerical vector. Typically a column from your demographics dataframe.

group2_data_column

the data for group2 as a numerical vector. Typically a column from your demographics dataframe.

Value

vector of strings, the lines of the report. You can print to STDOUT or write it to a file.


dfsp-spirit/fsbrain documentation built on Nov. 28, 2024, 10:29 a.m.