printStats: Print a Formatted Stats String from LM Object

In Cmell/ResultsHelper: Functions for writing automated Results sections.

Description

Print a Formatted Stats String from LM Object

Usage

printStats(param, modObj, asCor = F, ...)

Arguments

param	The parameter of interest. The shortcut "int" is recognized.
modObj	The lm or summary.lm object.
asCor	Should the stats be reported as a correlation? Defaults F.
...	Other options.
template	A string specifying which stats to include in this string. See details for how to construct a string. If left as NULL, the default template is used.

Details

The template argument is a string containing a sequence of the following characters, each separated by an underscore:

• b: An estimated regression coefficient, e.g., b=1.10

• r: Report a coefficient as a correlation, e.g., r(35)=0.45

• f: An 1-degree-of-freedom F-statistic, e.g., F(1,36)=4.2

• t: A t-statistic, e.g., t(38)=2.1

• p: A p-value, e.g., p=.03 or p<.01 depending on the value

• eta2: An η^2_p value, e.g., η^2_p=.056

• m: A mean, e.g., M=.45.

• sd: A standard deviation, e.g., SD=.34

• ci: A confidence interval, e.g., 95\%CI[.01, 2.34]

Note that the same set of ... arguments is passed to every function call. Otherwise, the strings are built with default argument values as normal.

If asCor=T, the reporting is as a correlation. If there is more than 1 slope in the model object, the correlation is reported as partial.

Cmell/ResultsHelper documentation built on April 10, 2020, 9:29 p.m.