R/rmd_templates.R

In katekathrynkat/katereR: Kate's Favorite Templates

#################################################
#####     R Markdown document templates     #####
#################################################

# Packages
library(rmarkdown)
library(htmltools)

# Analysis template
t_analysis <- function(toc = TRUE, code_folding = "hide", df_print = "paged") {

  # get the locations of CSS file located within the package
  css <- system.file("rmarkdown", "templates",
                     "CSS", "style_base.css", package = "katereR")

  # call the base html_document function
  rmarkdown::html_document(theme = "flatly",
                           highlight = "pygments",
                           css = css,
                           toc = toc,
                           toc_float = TRUE,
                           toc_depth = 3,
                           number_sections = FALSE,
                           df_print = df_print,
                           code_folding = code_folding
  )
}

# Index template
t_index <- function(toc = FALSE, code_folding = "none", df_print = "paged") {

  # get the locations of CSS file located within the package
  css <- system.file("rmarkdown", "templates",
                     "CSS", "style_index.css", package = "katereR")
  
  # call the base html_document function
  rmarkdown::html_document(theme = "flatly",
                           highlight = "pygments",
                           css = css,
                           toc = toc,
                           toc_float = TRUE,
                           toc_depth = 3,
                           number_sections = FALSE,
                           df_print = df_print,
                           code_folding = code_folding
  )
}

# Metadata template
t_datasets <- function(toc = TRUE, code_folding = "hide", df_print = "paged") {

  # get the locations of CSS file located within the package
  css <- system.file("rmarkdown", "templates",
                     "CSS", "style_base.css", package = "katereR")
  
  # call the base html_document function
  rmarkdown::html_document(theme = "flatly",
                           highlight = "pygments",
                           css = css,
                           toc = toc,
                           toc_float = TRUE,
                           toc_depth = 3,
                           number_sections = FALSE,
                           df_print = df_print,
                           code_folding = code_folding
  )
}

# Notes template
t_notes <- function(toc = FALSE, code_folding = "none", df_print = "paged") {
  
  # get the locations of CSS file located within the package
  css <- system.file("rmarkdown", "templates",
                     "CSS", "style_base.css", package = "katereR")
  
  # call the base html_document function
  rmarkdown::html_document(theme = "flatly",
                           highlight = "pygments",
                           css = css,
                           toc = toc,
                           toc_float = TRUE,
                           toc_depth = 3,
                           number_sections = FALSE,
                           df_print = df_print,
                           code_folding = code_folding
  )
}

# Simple template
t_simple <- function(toc = FALSE, code_folding = "none", df_print = "paged") {

  # get the locations of CSS file located within the package
  css <- system.file("rmarkdown", "templates",
                     "CSS", "style_base.css", package = "katereR")
  
  # call the base html_document function
  rmarkdown::html_document(theme = "flatly",
                           highlight = "pygments",
                           css = css,
                           toc = toc,
                           toc_float = TRUE,
                           toc_depth = 3,
                           number_sections = FALSE,
                           df_print = df_print,
                           code_folding = code_folding
  )
}