R/mxSummaryDS.R

In datashield/dsMx: Datashield package for advanced structural equation modelling

#'
#' @title Generates the summary from the output of an 'mxRun' fit
#' @description This function ensures the summaries returned to user 
#' contain no potentially disclosive information. It gets the summary 
#' already produced and stored on the server site and removes potentially
#' disclosive elements.
#' @details It essentially removes the min and max values from the
#' summaries and store the summary items in a list that is returned.
#' @param input an object of type "MxModel", the ouput of an 'mxRun' fit.
#' @return a list that holds the summary items.
#' @export
#' @author A. Gaye
#' 
mxSummaryDS <- function (input){
  library(OpenMx)
  output <- OpenMx::summary(input)
  # remove non relevant information
  idx1 <- which(names(output) %in% c("frontendTime", "backendTime", "independentTime", "wallTime", "cpuTime"))
  if(length(idx1) > 0){ output <- output[-idx1] }
  
  # remove the min and max values from the summary
  idx2 <- which(names(output) == "dataSummary")
  if(length(idx2) > 0){
    l <- length(output[idx2][[1]])
    for(i in 1:l){
      lrw <- dim(output$dataSummary[[i]])[1]
      output$dataSummary[[i]][1,] <- c(rep("Min.   :------  ",2))
      output$dataSummary[[i]][lrw,] <- c(rep("Max.   :------  ",2))
    }
  }

  return(output)
}