File: summary.mnp.Rd

package info (click to toggle)
r-cran-mnp 2.5-6-2
  • links: PTS
  • area: main
  • in suites: lenny
  • size: 392 kB
  • ctags: 28
  • sloc: ansic: 871; makefile: 14
file content (53 lines) | stat: -rw-r--r-- 1,658 bytes parent folder | download | duplicates (5)
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
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
\name{summary.mnp}

\alias{summary.mnp}
\alias{print.summary.mnp}

\title{Summarizing the results for the Multinomial Probit Models}

\description{
  \code{summary} method for class \code{mnp}.
}

\usage{
  \method{summary}{mnp}(object, CI=c(2.5, 97.5), ...)

  \method{print}{summary.mnp}(x, digits = max(3, getOption("digits") - 3), ...)
}

\arguments{
  \item{object}{An output object from \code{mnp}.}
  \item{CI}{A 2 dimensional vector of lower and upper bounds for the
    credible intervals used to summarize the results. The default is the
    equal tail 95 percent credible interval.
  }
  \item{x}{An object of class \code{summary.mnp}.}
  \item{digits}{the number of significant digits to use when printing.}
  \item{...}{further arguments passed to or from other methods.}
}

\value{
  \code{summary.mnp} yields an object of class \code{summary.mnp}
  containing the following elements:
  \item{call}{The call from \code{mnp}.}
  \item{n.alt}{The total number of alternatives.}
  \item{base}{The base category used for fitting.}
  \item{n.obs}{The number of observations.}
  \item{n.param}{The number of estimated parameters.}
  \item{n.draws}{The number of Gibbs draws used for the summary.}
  \item{coef.table}{The summary of the posterior distribution of the
    coefficients. }
  \item{cov.table}{The summary of the posterior distribution of the
    covariance matrix.}
  This object can be printed by \code{print.summary.mnp}
}

\seealso{\code{mnp}; MNP home page at
  \url{http://imai.princeton.edu/research/MNP.html}}

\author{
  Kosuke Imai, Department of Politics, Princeton University
  \email{kimai@Princeton.Edu}
}

\keyword{methods}