File: nMclustParams.Rd

package info (click to toggle)
r-cran-mclust 6.1.1-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 5,540 kB
  • sloc: fortran: 13,298; ansic: 201; sh: 4; makefile: 2
file content (52 lines) | stat: -rw-r--r-- 1,518 bytes parent folder | download | duplicates (4)
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
\name{nMclustParams}
\alias{nMclustParams}

\title{Number of Estimated Parameters in Gaussian Mixture Models}

\description{
 Gives the number of estimated parameters for parameterizations of the 
 Gaussian mixture model that are used in MCLUST. 
}
\usage{
nMclustParams(modelName, d, G, noise = FALSE, equalPro = FALSE, \dots)
}
\arguments{
  \item{modelName}{
    A character string indicating the model. The help file for
    \code{\link{mclustModelNames}} describes the available models.
  }
  \item{d}{
    The dimension of the data. Not used for models in which neither
    the shape nor the orientation varies.
  }
  \item{G}{
    The number of components in the Gaussian mixture model used to compute
    \code{loglik}.
  }
  \item{noise}{
    A logical variable indicating whether or not the model includes an
   optional Poisson noise component. 
  }
  \item{equalPro}{
    A logical variable indicating whether or not the components in the
    model are assumed to be present in equal proportion.
  }
   \item{\dots }{
   Catches unused arguments in indirect or list calls via \code{do.call}.
  }
}
\value{
  The number of variance parameters in the corresponding Gaussian mixture
  model. 
}
\details{
  To get the total number of parameters in model, add \code{G*d} for the
  means and \code{G-1} for the mixing proportions if they are unequal.
}
\seealso{
  \code{\link{bic}}, \code{\link{nVarParams}}.
}
\examples{
mapply(nMclustParams, mclust.options("emModelNames"), d = 2, G = 3)
}
\keyword{cluster}