createTexreg: Create a texreg object

Description Usage Arguments Details Author(s) References See Also Examples

View source: R/classDefinition.R

Description

Create a texreg object with coefficients and GOF statistics.

Usage

1
2
3
createTexreg(coef.names, coef, se, pvalues = numeric(0), ci.low = numeric(0), 
    ci.up = numeric(0), gof.names = character(0), gof = numeric(0), 
    gof.decimal = logical(0), model.name = character(0))

Arguments

coef.names

A vector of coefficient names.

coef

The coefficient values.

se

The standard errors. This is optional if the ci.low and ci.up slots are filled.

pvalues

The p-values of the model. This is optional.

ci.low

Lower bound of confidence interval (the actual values, not the confidence level). This is optional as long as se is available, but if it is provided, ci.up must also be provided.

ci.up

Upper bound of confidence interval (the actual values, not the confidence level). This is optional as long as se is available, but if it is provided, ci.low must also be provided.

gof.names

A vector of names of the goodness-of-fit statistics.

gof

A vector of goodness-of-fit statistics.

gof.decimal

A vector of boolean/logical values indicating for each GOF statistic if decimal places shall be used. This is optional.

model.name

The name of the model. In some cases, models consist of two separate columns because two separate data-generating processes are modeled. In these cases, it may make sense to specify default names for the columns (that is, for each texreg object). This argument is optional.

Details

This function creates a texreg object. A texreg object contains information about coefficients, standard errors, p values (optional), and about goodness-of-fit statistics. Instead of standard errors and p values, a texreg object may also contain upper and lower bounds of a confidence interval. texreg objects are used by the texreg command to create LaTeX tables and other representations of the model results.

Author(s)

Philip Leifeld (http://www.philipleifeld.com)

References

Leifeld, Philip (2013). texreg: Conversion of Statistical Model Output in R to LaTeX and HTML Tables. Journal of Statistical Software, 55(8), 1-24. http://www.jstatsoft.org/v55/i08/.

See Also

texreg-package texreg

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
library(nlme)  #load library for fitting linear mixed effects models
model <- lme(distance ~ age, data = Orthodont, random = ~ 1)  #estimate model
coefficient.names <- rownames(summary(model)$tTable)  #extract coefficient names
coefficients <- summary(model)$tTable[, 1]  #extract coefficient values
standard.errors <- summary(model)$tTable[, 2]  #extract standard errors
significance <- summary(model)$tTable[, 5]  #extract p values

lik <- summary(model)$logLik  #extract log likelihood
aic <- summary(model)$AIC  #extract AIC
bic <- summary(model)$BIC  #extract BIC
n <- nobs(model)  #extract number of observations
gof <- c(aic, bic, lik, n)  #create a vector of GOF statistics
gof.names <- c("AIC", "BIC", "Log Likelihood", "Num. obs.")  #names of GOFs
decimal.places <- c(TRUE, TRUE, TRUE, FALSE)  #the last one is a count variable

#create the texreg object
tr <- createTexreg(
  coef.names = coefficient.names, 
  coef = coefficients, 
  se = standard.errors, 
  pvalues = significance, 
  gof.names = gof.names, 
  gof = gof, 
  gof.decimal = decimal.places
)

Example output

Version:  1.36.23
Date:     2017-03-03
Author:   Philip Leifeld (University of Glasgow)

Please cite the JSS article in your publications -- see citation("texreg").

texreg documentation built on May 29, 2017, 7:54 p.m.