R/f.get.reg.output.R

In awmeade/psymetlab: Provides useful functions for APA formatting and writing output to Excel

#' Take output from lm function and put relevant info into a dataframe
#'
#' Returns a dataframe with predictors and coefficients listed along with model statistics 
#' F,df,p, and r-squred values.
#'
#'
#' @param out.lm results of a linear regression from lm()
#' @author Adam Meade \email{awmeade@@ncsu.edu}
#' @export 
#' @examples
#' \dontrun{
#' model.out <- lm(sat.act[,1]~sat.act[,2]+sat.act[,3])
#' f.get.reg.output(model.out)
#' }
f.get.reg.output <- local(function(out.lm){
  the.model <- summary(out.lm)$call
  #get.model <- toString(the.model)
  coef <- round(summary(out.lm)$coefficients,2)
  f <- as.matrix(round(summary(out.lm)$fstatistic,2))
  p <- round(pf(f[1],f[2],f[3],lower.tail=F),3)
  r2 <- round(summary(out.lm)$r.squared,2)
  r <- round(sqrt(r2),2)
  r2.adj <- round(summary(out.lm)$adj.r.squared,2)
  f.stats <- rbind(f,p,r,r2,r2.adj)
  x <- matrix(NA, ncol = ncol(coef), nrow = 7)
  x[,1] <- f.stats
  row.names(x) <- c("F value","df1","df2","p","r","r-sq","adj.r-sq")
  return.me <- rbind(coef,x)
  #return.me <- cbind(return.me,get.model)
  return(return.me)
})