R/endrtf.R

In JVAdams/EchoNet2Fish: Estimate Fish Abundance from Acoustic Echoes and Net Catch

#' Write and Close an RTF Document
#'
#' Write and close an rtf (rich text format) document.
#' @param rtf
#'   An rtf object, default \code{doc}.
#' @param details
#'   Logical scalar indicating if session details should be added to
#'   the end of the document, default FALSE.
#' @param ...
#'   Additional parameters to \code{rtf::addPageBreak}.
#' @references
#'   This is a copy of the \code{endrtf} function from the
#'   \href{https://github.com/JVAdams/GLFC}{[GLFC]} package.
#' @seealso
#'   \code{\link{startrtf}} for an example, \code{\link{heading}},
#'   \code{\link{para}}, \code{\link{tabl}},
#'   \code{\link{figu}},
#'   \code{\link[rtf]{RTF}}, \code{rtf::addPageBreak}.
#' @import
#'   rtf
#' @export

endrtf <- function(rtf=doc, details=TRUE, ...) {
  if (details==TRUE) {
    addPageBreak(rtf, ...)
    addSessionInfo(rtf)
    }
  done(rtf)
  }