R/warnprnt.R

In USEPA/spsurvey: Spatial Sampling Design and Analysis

###############################################################################
# Function: warnprnt (exported)
# Programmer: Tom Kincaid
# Date: June 18, 2020
#
#' Print grts(), irs()), and analysis function warnings
#'
#' This function prints the warnings messages from the \code{grts()}, \code{irs()},
#'   and analysis functions.
#'
#' @param warn_df Data frame that contains warning messages.  The default is
#'   \code{"warn_df"}, which is the name given to the warnings data frame created by
#'   functions in the spsurvey package.
#'
#' @param m Vector of indices for warning messages that are to be printed. The
#'   default is a vector containing the integers from 1 through the number of
#'   rows in \code{warn_df}, which will print all warning messages in the data frame.
#'
#' @return Printed warnings.
#'
#' @author Tom Kincaid \email{Kincaid.Tom@@epa.gov}
#'
#' @export
###############################################################################

warnprnt <- function(warn_df = get("warn_df", envir = .GlobalEnv),
                     m = 1:nrow(warn_df)) {

  # old front code in warndsgn
  # for (i in m) {
  #   cat(paste(
  #     "Message", i, ": Stratum:", warn_df$stratum[i],
  #     "Function: ", warn_df$func[i], "\n"
  #   ))
  #   cat(paste("     ", warn_df$warning[i], "\n"))
  # }

  for (i in m) {
    if ("Warning" %in% names(warn_df)) {
      message(paste0("Warning Message ", i, ":\n"))
      message(paste("Stratum:", warn_df$stratum[i], "\n"))
      message(paste("Warning:", warn_df$Warning[i], "\n"))
    } else {
      message(paste0("Warning Message ", i, ":\n"))
      # message(paste("Function:", warn_df$func[i], "\n")) # removed function name output
      if (sum(!is.null(warn_df$subpoptype[i]), is.na(warn_df$subpoptype[i]))) {
        message(paste("Population Type:", warn_df$subpoptype[i], "\n"))
      }
      if (sum(!is.null(warn_df$subpop[i]), is.na(warn_df$subpop[i]))) {
        message(paste("Subpopulation:", warn_df$subpop[i], "\n"))
      }
      if (sum(!is.null(warn_df$indicator[i]), is.na(warn_df$indicator[i]))) {
        message(paste("Indicator:", warn_df$indicator[i], "\n"))
      }
      if (sum(!is.null(warn_df$stratum[i]), is.na(warn_df$stratum[i]))) {
        message(paste("Stratum:", warn_df$stratum[i], "\n"))
      }
      message(paste("Warning:", warn_df$warning[i]))
      if (sum(!is.null(warn_df$action[i]), is.na(warn_df$action[i]))) {
        message(paste("Action:", warn_df$action[i], "\n"))
      }
    }
  }

  invisible(NULL)
}