R/atx_header.R

In MVR-GIS/rarr: Risk Analysis Report in R

#' @title ATX-Style Markdown Header
#'
#' @description Produces the ATX-style markdown header (i.e., a number of
#'   hashes) for the input header level.
#'
#' @export
#'
#' @param level    numeric; Integer number of header level.
#'
#' @return String of ATX-style markdown header.
#'
#' @examples
#' h1 <- atx_header(1)
#' h2 <- atx_header(2)
#' h3 <- atx_header(3)
#' h4 <- atx_header(4)
#'
atx_header <- function (level) {
  if(!is.numeric(level)) {stop ("level must be numeric")}
  if(level%%1 != 0) { stop("level must be an integer") }
  if(level == 0) {stop("level cannot be zero")}
  if(level > 5) {stop("level cannot reasonably be greater than five")}

  paste(rep.int("#", level), collapse = "")
}