Skip to contents

Assemble RTF files from an assembly spec (deprecated)

Source: R/assemble_spec.R
assemble_from_spec.Rd

Deprecated in 0.8.x (warns once a session, still works); removed in 0.9.0. It is assemble_rtf(toc = spec): assemble_rtf() takes the table (or its .xlsx / .csv path) as toc.

Usage

assemble_from_spec(
  spec,
  output_file,
  toc_title = "Table of Contents",
  toc_leader = "dot",
  toc_page_numbering = "decimal",
  overwrite = FALSE,
  ...
)

Arguments

spec

An assembly-spec data.frame, or a path to a .xlsx / .csv spec file.

output_file

Path of the assembled .rtf to write.

toc_title, toc_leader, toc_page_numbering, overwrite, ...

Passed to assemble_rtf().

Value

Invisibly, output_file.

Details

Runs assemble_rtf() with a Table of Contents built from an assembly spec (a data.frame from assemble_spec(), or the path to a saved .xlsx / .csv spec). Rows are ordered by the spec's order column when present.

See also

assemble_spec(), assemble_folder(), assemble_rtf().

Examples

# two TFL files in a folder, as a study's output
dir <- file.path(tempdir(), "tfl")
dir.create(dir, showWarnings = FALSE)
for (t in c("14.1.1", "14.2.1")) {
  doc <- rtf_document() |>
    rtf_tables(data.frame(Parameter = "Age", Value = "75.1")) |>
    rtf_titles(list(c(paste("Table", t), "Safety Population")))
  generate_rtfreport(doc, file.path(dir, paste0("t", gsub(".", "_", t,
    fixed = TRUE), ".rtf")), overwrite = TRUE)
}
# instead
spec <- assemble_folder(dir)          # review / edit the order
assemble_rtf(toc = spec, output_file = tempfile(fileext = ".rtf"),
             toc_page_numbering = "decimal")