quartose (version 0.1.0)

quarto_format: Format a quarto object

Description

Creates a formatted representation of a quarto object in a form suitable for printing. When calling knitr::knit_print() on a quarto object, the relevant format() method is called first, and the formatted version is printed to the document. Note that the base print() method for quarto objects does not call format().

Usage

# S3 method for quarto_section
format(x, ...)
# S3 method for quarto_tabset
format(x, ...)
# S3 method for quarto_div
format(x, ...)
# S3 method for quarto_span
format(x, ...)
# S3 method for quarto_markdown
format(x, ...)
# S3 method for quarto_group
format(x, ...)

Value

A formatted quarto object. For quarto_section, quarto_span, and quarto_markdown objects, the formatted output is always a string (character vector of length 1). For quarto_tabset and quarto_group objects, the output is always a list whose elements are either strings or plot objects. For quarto_div objects, the output is currently a string, but this may change to list output in future if divs are permitted to contain plots.

Arguments

x

A quarto object.

...

Other arguments (ignored).

Details

The intent behind the format() methods for quarto objects is to create a ready-to-print representation of that is almost identical to what will be printed into the quarto document when knitr::knit_print() is called. Because of this, the formatted version of a quarto object is a string or a list of strings, but it may also include plot objects that have not yet been rendered. The resulting representation isn't always very pretty, though it is generally fairly readable.

Examples

# formatted sections, spans and divs ----------------------------------
sec <- quarto_section("Header", level = 2L)
spn <- quarto_span("Content", class = "underline")
div <- quarto_div("Content", class = "content-margin")

format(sec)

format(spn)

format(div)

# formatted tabsets ---------------------------------------------------
tbs <- quarto_tabset(
  content = list(tab1 = 1:10, tab2 = "hello"),
  title = "Header",
  level = 2L
)

format(tbs)

# formatted groups and markdown ---------------------------------------

mkd <- quarto_markdown(list("- this is a", "- markdown list"), sep = "\n")
gps <- quarto_group(list(div, mkd))

format(mkd)

format(gps)