R/model-ml-ei.R

In IQSS/ZeligEI: Zelig Ecological Inference Models

#' Ecological Inference Model by Maximum Likelihood
#'
#' Vignette: \url{http://docs.zeligproject.org/articles/zeligei_eiml.html}
#' @import methods
#' @export Zelig-eiml
#' @exportClass Zelig-eiml
#'
#' @include model-ei.R

zeiml <- setRefClass("Zelig-eiml",
                          contains = "Zelig-ei")

zeiml$methods(
  initialize = function() {
    callSuper()
    .self$name <- "eiml"
    .self$description <- "Ecological Inference Model by Maximum Likelihood"
    .self$fn <- quote(ei::ei)
    .self$packageauthors <- "Gary King, Molly Roberts"
    .self$wrapper <- "eiml"
    .self$vignette.url <- "http://docs.zeligproject.org/articles/zeligei_eiml.html"
    ref1<-bibentry(
            bibtype="Book",
            title = "A Solution to the Ecological Inference Problem: Reconstructing Individual Behavior from Aggregate Data",
            author = person("Gary", "King"),
            year = 1997,
            publisher = "Princeton University Press",
            organization = "Princeton University Press",
            address = "Princeton"
            )
    .self$refs<-c(.self$refs, ref1)
  }
)

zeiml$methods(
  zelig = function(formula, data, N = NULL, ..., weights = NULL, by = NULL, bootstrap = FALSE, na.action="na.omit") {
    na.action <- checkZeligEIna.action(na.action)

    #if(is.null(N)){
    #  stop("The argument N needs to be set to the name of the variable giving the total for each unit, or a vector of counts.")
    #}

    cnvt <- convertEIformula2(formula=formula, data=data, N=N, na.action=na.action)
    localformula <- cnvt$formula
    localdata <- cnvt$data

    .self$zelig.call <- match.call(expand.dots = TRUE)

    .self$model.call <- match.call(expand.dots = TRUE)
    .self$model.call$formula <- localformula
    .self$model.call$N <- NULL
    .self$model.call$na.action <- NULL
    .self$model.call$total <- cnvt$totalName

    # Check if N needs to be replaced in this model, or everything can rely on .self$model.call$total
    callSuper(formula = localformula, data = localdata, N=N, ..., weights = weights, by = by, bootstrap = bootstrap)
  }
)

zeiml$methods(
  param = function(z.out, method=NULL) {  # method arguments allows bootstrap.  However, the same object should be returned regardless.
    sim <- ei::ei.sim(z.out)
    return(sim)
  }
)

zeiml$methods(
  qi = function(simparam, mm) {

    if(.self$bootstrap){
      ev <- ei::eiread(simparam, "maggs")
    }else{
      ev <- ei::eiread(simparam, "aggs")
    }

    return(list(ev = ev))
  }
)

# Overwrite diagnostic test that are inherited from model-ei
zeiml$methods(
  geweke.diag = function() {
    stop("The eiml model is not estimated by Markov chain Monte Carlo, so this test for MCMC convergence is not needed.")
  } 
)

zeiml$methods(
  heidel.diag = function() {
    stop("The eiml model is not estimated by Markov chain Monte Carlo, so this test for MCMC convergence is not needed.")
  } 
)

zeiml$methods(
  raftery.diag = function() {
    stop("The eiml model is not estimated by Markov chain Monte Carlo, so this test for MCMC convergence is not needed.")
  } 
)