runFmdenq: Import Data and Calculate Intra- and Interclass Correlation...

View source: R/functions.R

runFmdenqR Documentation

Import Data and Calculate Intra- and Interclass Correlation Coefficients

Description

Imports FMD result data from a predefined xlsx file, calculates intra- and interclass correlation coefficients on some predefined and some optional custom data grouoings / splittings, and saves the statistics results to an xlsx file.

Usage

runFmdenq(
  fnIn = "results_fmd",
  selIn = FALSE,
  exclOneMT = FALSE,
  inclOneMT = TRUE,
  ther.sub = NULL,
  lmer = TRUE,
  verbose = TRUE,
  fnOut = "results_stat",
  toXls = TRUE
)

Arguments

fnIn

Character length one, the name of the data-input file, what is an xlsx file residing in the folder 'results_fmd'. (The name is provided without the '.xlsx' ending.)

selIn

Logical, if an xlsx file should be selected interactively instead. Defaults to FALSE.

exclOneMT

Logical, if additional groupings with one muscle test excluded should be performed. Defaults to FALSE.

inclOneMT

Logical, if additional groupings with only one muscle test included should be performed. Defaults to TRUE.

ther.sub

NULL or List. If left at the default NULL, no additional splitting with therapist subgroups is performed. Provide a list with n therapist IDs in each list element to calculate additional inter-rater correlation coefficients on data split by therapist subgroups defined in each list element; see examples.

lmer

Logical. Should the lmer function from packakge lme4 be used for calculating the ICC via package psych.

verbose

Logical, if various status reports / feedback should be given. Defaults to TRUE.

fnOut

Character length one. The filename (without the ending '.xlsx') of the xlsx file where the statistics results will be saved to.

toXls

Logical, if statistics results should be saved to xlsx. Defaults to TRUE.

Details

The name of the input-excel file can be specified or it can be interactively selected, the name of the output-excel file can be specified. This basically is a convenient wrapper for the two functions importData and calcIntraInter; see examples there.

Calculating ICC

For calculating the resp. ICC, function ICC from package psych is used.

See Also

importData, calcIntraInter

Examples

## Not run: 
runFmdenq()
runFmdenq(selIn=TRUE, fnOut="results_stat_foo") # interactively select xlsx file for data import

## End(Not run)

bpollner/fmdenq documentation built on March 27, 2022, 4:26 p.m.