R/bhlm_classes.R

In arcuo/BHLM_package: Bayesian Hierarchical Latent Mixture model meta analysis and plots.

#' An S4 class to contain the used data for \code{latent_mixture} from the preprocessing.
#'
#' @slot used_data The updated dataframe of the data, after preprocessing.
#' @slot start_bounds Starting bounds between studies for the looping through estimates.
setClass(Class="bhlm_data",
         slots = c(
           used_data="data.frame",
           start_bounds = "numeric"
         )
)

#' An S4 class to contain the results and used data of \code{latent_mixture}.
#'
#' @slot data latent_mixture_data object, including the data used in the latent mixture model.
#' @slot jags_samples rjags object from R2Jags.
setClass(Class="bhlm_object",
         contains = c("bhlm_data"),
         slots = c(
           jags_samples = "rjags",
           outcome_options = "character",
           outcome_priors_c = "character",
           outcome_priors_m = "matrix",
           estimate_name = "character"
         )
)

# Summary function

summary.bhlm_object <- function(object, ...) {

  #Map, prob below null hyp, rhat, n.eff, bf01/10

  message("No custom summary function yet... default for now.")
  summary.default(object)

}