R/heading.R

Defines functions heading

Documented in heading

#' Print as heading
#'
#' @description
#' heading prints an input string in a "heading" format
#'
#' @details
#' A function primarily for aesthetics within the PathWAS pipeline and for progress checks throughout.
#'
#' @param sentence character. A string of variable length for printing.
#'
#' @export
heading = function(sentence) {

  cat(paste0("\n\n\n=======================\n\n",
                   sentence, "\n===========================\n\n"))
}
Sabor117/PathWAS documentation built on Nov. 29, 2024, 7:44 a.m.