summary.fmlogit: Generate summary tables for fmlogit objects

In f1kidd/fmlogit: Fractional Multinomial Logit using QMLE

Generate summary tables for fmlogit objects

Description

Generate tables of coefficient estimates, partial effects, and willingness to pay from fmlogit-type objects.

Usage

## S3 method for class 'fmlogit'
summary(object, varlist = NULL, sepline = F,
  digits = 3, add.info = T, list = T, sigcode = c(0.05, 0.01,
  0.001), print = F)

## S3 method for class 'fmlogit.margins'
summary(object, varlist = NULL, sepline = F,
  digits = 3, add.info = T, list = T, sigcode = c(0.05, 0.01,
  0.001), print = F)

## S3 method for class 'fmlogit.wtp'
summary(object, varlist = NULL, sepline = F,
  digits = 3, sigcode = c(0.05, 0.01, 0.001), print = F)

Arguments

object	an object with class "fmlogit", "fmlogit.margins", or "fmlogit.wtp".
varlist	select a subset of variable names to be processed. Default to NULL, of which all variables will be processed.
sepline	whether the output table uses separate lines for coefficients and standard errors.
digits	number of digits to be signifed. Default to show 3 digits.
add.info	whether to add additional descriptive information to the output.
list	whether to output a list object, or a single data frame.
sigcode	the significance code to be used. Has to be a three-component vector.

Details

This module provides summary methods for three fmlogit objects: fmlogit, fmlogit.margins , and fmlogit.wtp.

The summary method offers several options to the users. The user can choose for a list output list=T, which is good for display and quoting purposes, or a data frame output list=F, which is good for table outputs. The user can also specify whether to provide additional information other than the parameter estimates, whether to use seperate lines for the estimates and the standard errors (which mimics the output style in Stata), as well as the significance code.

Value

Either a list (for display purposes) or a data.frame (for csv output purposes). If list return (which is the default) is selected, then the list will contain 4 components: $estimates the estimate; $N number of observations, $llf value of the log-likelihood function; and $baseline the name of the baseline choice.

Examples

# generate fmlogit summary
#results1 = fmlogit(y,X)

# generate marginal effects summary
#effects1 = effects(results1,effect="marginal")
summary(effects1)

# generate latex style output
# require(xtable)
xtable(summary(effects1,list=F,sepline=T))

f1kidd/fmlogit documentation built on June 26, 2022, 4:33 p.m.