File: multilevel_missing_data.frame.Rd

package info (click to toggle)
r-cran-mi 1.2-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 1,380 kB
  • sloc: sh: 13; makefile: 2
file content (43 lines) | stat: -rw-r--r-- 1,721 bytes parent folder | download | duplicates (6)
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
\name{multilevel_missing_data.frame}
\Rdversion{1.1}
\docType{class}
\alias{multilevel_missing_data.frame}
\alias{multilevel_missing_data.frame-class}
\title{Class "multilevel_missing_data.frame"}
\description{
This class inherits from the \code{\link{missing_data.frame-class}} but is customized for the situation
where the sample has a multilevel structure.
}
\section{Objects from the Class}{
Objects can be created by calls of the form \code{new("multilevel_missing_data.frame", ...)}.
However, its users almost always will pass a \code{\link{data.frame}} to the 
\code{\link{missing_data.frame}} function and specify the \code{subclass} and \code{groups} arguments.
}
\section{Slots}{
  The multilevel_missing_data.frame class inherits from the \code{\link{missing_data.frame-class}} and
  has two additional slots
  \describe{
    \item{groups}{Object of class \code{\link{character}} indicating which variables define the 
      multilevel structure}
    \item{mdf_list}{Object of class \code{mdf_list} whose elements contain a \code{\link{missing_data.frame}}
      for each group. This slot is filled automatically by the \code{\link{initialize}} method.}
  }
}
\details{
  The \code{\link{fit_model-methods}} for the multilevel_missing_data.frame class will, by default, utilize 
  multilevel modeling techniques that shrink the estimated parameters for each group toward their global
  means.
}
\author{
Ben Goodrich and Jonathan Kropko, for this version, based on earlier versions written by Yu-Sung Su, Masanao Yajima,
Maria Grazia Pittau, Jennifer Hill, and Andrew Gelman.
}
\seealso{
\code{\link{missing_data.frame}}
}
\examples{
## Write example
}
\keyword{classes}
\keyword{manip}
\keyword{AimedAtUseRs}