Skip to contents

Add a footer row

Source: R/spec_context.R
add_footer.Rd

Generic function to add footer rows. Dispatches to class-specific methods, allowing footers to be added to both spec objects and global options.

Usage

add_footer(spec = NULL, ..., level = NULL)

Arguments

spec

Spec object (dispatches on class)

...

Up to 3 character strings (left, center, right)

  • Positional parts represent left, center and right header/footer cells respectively.

  • Supply fewer than 3 parts if some cells should be empty; use empty string "" for explicit empties.

  • Each call appends one header/footer row; use the level parameter to replace an existing row.

level

Optional numeric index. If provided, replaces footer at that row. If NULL, appends next row.

Value

Updated spec object

Details

Each call adds a new footer row. Per schema, footers are arrays of arrays (each call = one row).

Examples

if (FALSE) { # \dontrun{
# Add to a spec object
spec <- create_text() |>
  add_footer("Company Name", "", "Page {PAGE} of {NUMPAGES}") |>
  add_footer("", "Confidential", "")

# Add to global options
options <- tfl_get_options()
options <- add_footer(options, "Company Name", "", "Page {PAGE} of {NUMPAGES}")
} # }