Skip to contents

Convert an apa_table to a flextable

Source: R/api-reports.R
as_flextable.apa_table.Rd

Produces a Word / PowerPoint-friendly flextable with the caption and note wired in. Requires flextable (in Suggests).

Usage

# S3 method for class 'apa_table'
as_flextable(x, ...)

Arguments

x

An apa_table object from apa_table().

...

Reserved for generic compatibility.

Value

A flextable object, or a message when flextable is unavailable.

See also

as_kable.apa_table(), apa_table().

Examples

# Supplementary workflow: run explicitly to keep routine checks brief.
# example("as_flextable.apa_table", run.dontrun = TRUE)
if (FALSE) { # \dontrun{
tbl <- structure(
  list(
    table = data.frame(Term = c("Rater A", "Rater B"), Estimate = c(-0.12, 0.18)),
    caption = "Facet estimates",
    note = "Toy values for formatting only."
  ),
  class = "apa_table"
)
if (requireNamespace("flextable", quietly = TRUE)) {
  invisible(as_flextable(tbl))
}
} # }