regr {yhat}R Documentation

Regression effect reporting for lm class objects

Description

The regr reports beta weights, standardized beta weights, structure coefficients, adjusted effect sizes, and commonality coefficients for lm class objects.

Usage

regr(lm.out)

Arguments

lm.out lm class object

Details

The function regr takes the lm class object and reports beta weights, standardized beta weights, structure coefficients, adjusted effect sizes, and commonality coefficients for lm class objects.

Value

return(list(LM_Output=summary(lm.out), Beta_Weights=beta.out, Structure_Coefficients=structure.coef, Commonality_Data=CCdata[1], Effect_Size=es, Comment="The Effect Size recommendations are based on Yin and Fan (2001). Your dataset may take on a different covariance structure, thus making another effect size estimate more appropriate."))

LM_Output The summary of the output from the lm class object
Beta_Weights Beta weights for the regression effects
Structure_Coefficients Structure coefficients for the regression effects
Commonality_Data Commonality coefficients for the regression effects. The output only produces a parsed version of CCdata
Effect_Size Adjusted effect size computations based on R^2 adjustments

Author(s)

J. Kyle Roberts <kyler@smu.edu>, Kim Nimon <kim.nimon@gmail.com>

References

Nimon, K., Lewis, M., Kane, R. & Haynes, R. M. (2008) An R package to compute commonality coefficients in the multiple regression case: An introduction to the package and a practical example. Behavior Research Methods, 40(2), 457-466.

Yin, P., & Fan. X. (2001) Estimated R^2 shrinkage in multiple regression: A comparison of different analytical methods. The Journal of Experimental Education, 69(2), 203-224.

See Also

Functions in the yhat library commonalityCoefficients, effect.size

Examples

     data(HS.data)
     attach(HS.data)
     lm.out<-lm(deduct~addition*arithmet)
     regr(lm.out)

[Package yhat version 1.0-3 Index]