R/class_mcmcSummary.R

In BaM-tools/RBaM: Bayesian Modeling: Estimate a Computer Model and Make Uncertain Predictions

#***************************************************************************----
# Constructor ----
#' mcmcSummary constructor.
#'
#' Creates a new instance of a 'mcmcSummary' object
#'
#' @param fname Character, configuration file name.
#' @param result.fname Character, summary file name.
#' @param DIC.fname Character, DIC file name. Not computed if empty string.
#' @param xtendedMCMC.fname Character, xtended MCMC file name. Not written if empty string.
#' @return An object of class 'mcmcSummary'.
#' @examples
#' m <- mcmcSummary()
#' @export
mcmcSummary<-function(fname="Config_Summary.txt",result.fname='Results_Summary.txt',
                      DIC.fname='Results_DIC.txt',xtendedMCMC.fname=''){
  o<-new_mcmcSummary(fname,result.fname,DIC.fname,xtendedMCMC.fname)
  return(validate_mcmcSummary(o))
}

#***************************************************************************----
# toString function ----
#' mcmcSummary to string
#'
#' Convert an object of class 'mcmcSummary' into a ready-to-write vector of string
#'
#' @param x mcmcSummary object, object to be converted.
#' @param ... Optional arguments.
#' @return A string ready to be printed or written.
#' @examples
#' toString(mcmcSummary())
#' @export
toString.mcmcSummary<-function(x,...){
  value=list(x$result.fname,x$DIC.fname,x$xtendedMCMC.fname)
  comment=c(
    'result.fname, name of MCMC summary file (|!| name of the file only, not full path)',
    'DIC.fname, name of DIC file (|!| name of the file only, not full path). Not computed if empty',
    'xtendedMCMC.fname, name of extended MCMC file (|!| name of the file only, not full path). Not written if empty')
  txt<-toString_engine(value,comment)
  return(txt)
}

#***************************************************************************----
# is function ----
#' mcmcSummary tester
#'
#' Is an object of class 'mcmcSummary'?
#'
#' @param o Object, an object.
#' @return A logical equal to TRUE if class(o)== 'mcmcSummary', FALSE otherwise.
#' @keywords internal
is.mcmcSummary<-function(o){
  return(class(o)=='mcmcSummary')
}

#***************************************************************************----
# internal constructor ----
new_mcmcSummary<-function(fname,result.fname,DIC.fname,xtendedMCMC.fname){
  stopifnot(is.character(fname))
  stopifnot(is.character(result.fname))
  stopifnot(is.character(DIC.fname))
  stopifnot(is.character(xtendedMCMC.fname))
  o <- list(fname=fname,result.fname=result.fname,DIC.fname=DIC.fname,xtendedMCMC.fname=xtendedMCMC.fname)
  class(o) <- 'mcmcSummary'
  return(o)
}

#***************************************************************************----
# validator ----
validate_mcmcSummary<-function(x){
  # nothing to do
  return(x)
}