R/afit_prospectus.R

In Auburngrads/AFIT: Rmarkdown Templates For Academic Documents at Department of Defense Schools

#' Air Force Institute of Technology Prospectus Template 
#'
#' Format for creating the initial pages of AFIT theses, dissertations, and reports.
#' 
#' Adapted from the STYLE GUIDE FOR AFIT DISSERTATIONS, THESES AND GRADUATE RESEARCH PAPERS - July 2015
#' \href{http://www.afit.edu/docs/NewAFITStyleGuideJuly2015(2).pdf}{http://www.afit.edu/docs/NewAFITStyleGuideJuly2015(2).pdf}
#'
#' @param ... Arguments to \code{rmarkdown::pdf_document}
#' @param keep_tex Should the raw TeX files be kept?
#' @param md_extensions Extensions passed to the Markdown engine
#' @param fig_caption Should figure captions be enabled?
#' @param toc Should a table of contents be created?
#' @param template The TeX template used
#' @param format The format of the document
#'
#' @return R Markdown output format to pass to \code{\link[rmarkdown:render]{render}}
#'
#' @importFrom rmarkdown pdf_document
#' @importFrom rmarkdown pandoc_highlight_args
#' @examples
#'
#' \dontrun{
#' rmarkdown::draft("MyThesis.Rmd", template = "afit_prospectus", package = "AFIT")
#' }
#'
#' @export
afit_prospectus <- function(...,
                            keep_tex = TRUE,
                            md_extensions = c("-autolink_bare_uris"),
                            fig_caption = TRUE,
                            toc = TRUE,
                            template = "template.tex",
                            format = "afit_prospectus") {
  
  rmarkdown::pdf_document(...,
                          template = system.file("rmarkdown", 
                                                 "templates", 
                                                 format, 
                                                 'resources',
                                                 template,
                                                 package = "AFIT"),
                          fig_caption = fig_caption,
                          keep_tex = keep_tex,
                          toc = toc,
                          pandoc_args = c('--listings'))
}