R/fun-add-footer.R

In huhuaping/techme: Generate Research Report with Complex Data Sources

#' Add success footer information item to item for the figure or table
#'
#' This function should be in the code chunk (always follow the code of plot or kable)
#'   and without setting "result= 'asis'".
#'
#' @param text character, information text.
#' @param type character, is one of c('note', 'source') and default 'note'
#'
#' @return invisible
#' @export add_footer_pure
#'
#' @examples
#' cap_note <- "This is a note, ba la ba la"
#' cap_source <- "source from yearbook 2021"
#' \dontrun{
#'  add_footer_pure(cap_note)
#'  cat("\n")
#'  add_footer_pure(cap_source, type = "source")
#' }
#'
#'
add_footer_pure <- function(text, type="note") {
  if (type=="note"& !is.null(text)) cat(text, sep = "")
  if (type == "source") cat(text, sep = "")
  if (type == "source" & is.null(text)) stop("You should set the 'source' at least!")
}


#' Add success footer information as whole part for the figure or table
#'
#' This function should be in the dependent code chunk (outside the code chunk of plot or kable)
#'   and must set the chunk options "result= 'asis'".
#'
#' @param note character, note text for figure or table.
#' @param source character, source text for figure or table.
#'
#' @importFrom stringr str_c
#'
#' @return invisible
#' @export add_footer_asis
#'
#' @examples
#'
#' cap_note <- "This is a note, ba la ba la"
#' cap_source <- "source from yearbook 2021"
#' \dontrun{
#'  add_footer_asis(cap_note, cap_source)
#' }
#'
add_footer_asis <- function(note, source) {
  out <- stringr::str_c(
    if (!is.null(note)) stringr::str_c(note),
    if (!is.null(note)) stringr::str_c("\n\n"),
    if (!is.null(note)) stringr::str_c("\\newline"),
    if (!is.null(note)) stringr::str_c("\n\n"),
    if (!is.null(source)) stringr::str_c(source)
  )

  cat(out, sep = "\n")
}

# reference
## 1. How to show formatted R output with results='asis' in rmarkdown [see](https://stackoverflow.com/questions/52631689/how-to-show-formatted-r-output-with-results-asis-in-rmarkdown)
## 2. Add Blank Line to Word Output RMarkdown [see](https://stackoverflow.com/questions/43239868/add-blank-line-to-word-output-rmarkdown)