r_tocForRmdFiles: Renders all found .Rmd files in actual working directory with...

View source: R/Rmarkdown_utiilities.R

r_tocForRmdFilesR Documentation

Renders all found .Rmd files in actual working directory with automatically created table of contents.

Description

Renders all found .Rmd files in actual working directory with automatically created table of contents.

Usage

r_tocForRmdFiles(
  render_type = c("html_document"),
  toc_heading_string = "Table of Contents",
  pagebreak_level = "non",
  create_nb = TRUE,
  nb_front = TRUE,
  set_first_heading_level = FALSE,
  delete_Rmd_file = TRUE
)

Arguments

render_type

choose the render type e.g. c("html_document","word_document","pdf_document")

toc_heading_string

title string for TOC, e.g "Inhaltsverzeichnis", default is "Table of contents".

pagebreak_level

Automatically add page breaks before new heading. Set the level to insert page breaks to e.g. c("non","1","2","3","4","5","6")

create_nb

boolean to enable numbering for each heading.

nb_front

boolean to have the numbering in front of each heading.

set_first_heading_level

set first found heading level to heading 1

delete_Rmd_file

boolean to delete the created .Rmd files.

Examples

print(getwd())

wagnius-GmbH/slvwagner documentation built on Jan. 19, 2025, 7:10 a.m.