gen_qmd_index {saros}R Documentation

Generate Quarto Index File That Merges All Chapters

Description

This function creates an index Quarto file (QMD) that merges all chapters in the specified order. It can also include optional title and author(s) information.

Usage

gen_qmd_index(
  index_filepath = "index.qmd",
  ...,
  chapter_filepaths = NULL,
  report_filepath = NULL,
  yaml_file = NULL,
  call = rlang::caller_env()
)

Arguments

index_filepath

Path to the output index.qmd file. Defaults to "complete_report.qmd"

...

Dynamic dots

<dynamic-dots>

Arguments forwarded to the corresponding functions that create the elements.

chapter_filepaths

A character vector containing the filepaths of the chapter files to be included in the index, in the desired order.

report_filepath

A string containing the filepath to the report.qmd.

yaml_file

A string containing the filepath to a yaml-file to be inserted at top of qmd-file.

call

Internal call argument. Not to be fiddled with by the user.

Value

A string containing the filepath to the generated Quarto index file.


[Package saros version 1.0.4 Index]