R/summarytext.R

In konkam/BNPdensity: Ferguson-Klass Type Algorithm for Posterior Normalized Random Measures

#' Common text for the summary S3 methods
#'
#' @param fit NRMIx or PYx object
#' @param kernel_comment Text specific to the parametric and nonparametric nature of the model
#' @param BNP_process_comment Text specific to the nonparametric process, NRMI or Pitman-Yor
#' @param number_of_clusters Flag to decide whether to compute the optimal clustering
#'
#' @return Prints out the text for the summary S3 methods
summarytext <- function(fit, kernel_comment, BNP_process_comment, number_of_clusters = FALSE) {
  ndata <- ifelse(is_censored(fit$data), nrow(fit$data), length(fit$data))
  data_comment <- paste("There were", ndata, "data points.")
  MCMC_comment <- paste("The MCMC algorithm was run for ", fit$Nit, " iterations with ", 100 * fit$Pbi, "% discarded for burn-in.", sep = "")
  if (number_of_clusters) {
    estimated_clustering <- compute_optimal_clustering(fit)
    clustering_comment <- paste("The estimated number of clusters in the data is ", length(unique(estimated_clustering)), ".", sep = "")
  }
  else {
    clustering_comment <- "To obtain information on the estimated number of clusters,\n please use summary(object, number_of_clusters = TRUE)."
  }
  writeLines(paste(BNP_process_comment, "\n\n", kernel_comment, "\n\n", data_comment, "\n\n", MCMC_comment, "\n\n", clustering_comment, sep = ""))
}