report: Reporting function for 'repMean', 'repTable', 'repQuantile',...

In weirichs/eatRep: Educational Assessment Tools for Replication Methods

Reporting function for repMean, repTable, repQuantile, and repGlm

Description

Summarizes the output of the four main functions repMean,repTable, repQuantile, and repGlm, and provides a single data.frame with all results.

Usage

report(repFunOut, trendDiffs = FALSE, add = list(),
      exclude = c("NcasesValid", "var", "sampleSize"), printGlm = FALSE,
      round = TRUE, digits = 3, printDeviance = FALSE)

Arguments

repFunOut	output of one of the four eatRep-functions.
trendDiffs	Logical: compute differences of trends?
add	Optional: additional columns for output. See examples of the jk2-functions
exclude	Which parameters should be excluded from reporting?
printGlm	Only relevant for repGlm: print summary on console?
round	Logical: should the results be rounded to a limited number of digits?
digits	How many digits should be used for rounding?
printDeviance	Only relevant for repGlm when other than the identical function is used as link function, and if printGlm is TRUE. Should the deviance information printed additionally? Note: To print deviance information, the argument poolMethod of the repGlm function must be set to "scalar".

Value

A data frame with at least nine columns.

group	Denotes the group an analysis belongs to. If no groups were specified and/or analysis for the whole sample were requested, the value of ‘group’ is ‘wholeGroup’.
depVar	Denotes the name of the dependent variable in the analysis.
modus	Denotes the mode of the analysis. For example, if a JK2 regression analysis was conducted, ‘modus’ takes the value ‘JK2.glm’. If a mean analysis without any replicates was conducted, ‘modus’ takes the value ‘CONV.mean’.
comparison	Denotes whether group mean comparisons or cross-level comparisons were conducted. Without any comparisons, ‘comparison’ takes the value ‘NA’
parameter	Denotes the parameter of the corresponding analysis. If regression analysis was applied, the regression parameter is given. Amongst others, the ‘parameter’ column takes the values ‘(Intercept)’ and ‘gendermale’ if ‘gender’ was the independent variable, for instance. If mean analysis was applied, the ‘parameter’ column takes the values ‘mean’, ‘sd’, ‘var’, or ‘Nvalid’. See the examples of repMean,repTable, repQuantile, or repGlm for further details.
depVar	Denotes the name of the dependent variable (only if repGlm was called before)
est	Denotes the estimate of the corresponding analysis.
se	Denotes the standard error of the corresponding estimate.
p	Denotes the p value of the estimate.

Author(s)

Benjamin Becker, Sebastian Weirich

Examples

### see examples of the eatRep main functions.

weirichs/eatRep documentation built on April 13, 2024, 2:18 a.m.