jared
4f51a49903
R-CMD-check / R CMD check (pull_request) Successful in 4m20s
Generalize the flextable brand styling and "export to PNG + stamp logo" pattern repeated across Civilytics projects into two small functions: - style_flextable_civilytics(): applies only the visual brand (header fill/color, body font/size, zebra striping guarded for <2 rows, borders, footer styling, fixed layout) to an already-structured flextable. Every value is an overridable parameter; zebra toggles striping. Structure (labels, headers, widths, alignment, footer text) stays with the caller. - save_branded_flextable_png(): exports a styled flextable to PNG via ragg::agg_png() sized to the table plus extra_height headroom, then optionally stamps the logo via stamp_logo_png() (... forwarded). flextable, officer, and ragg are added to Suggests (not Imports) to keep the base install light; both functions reference them fully qualified and guard with requireNamespace() + an install hint. Real round-trip tests cover styling, 1-row idempotence, PNG export, and extra_height.
63 lines
1.9 KiB
R
63 lines
1.9 KiB
R
% Generated by roxygen2: do not edit by hand
|
|
% Please edit documentation in R/flextable.R
|
|
\name{save_branded_flextable_png}
|
|
\alias{save_branded_flextable_png}
|
|
\title{Save a branded flextable to a logo-stamped PNG}
|
|
\usage{
|
|
save_branded_flextable_png(
|
|
ft,
|
|
path,
|
|
logo = TRUE,
|
|
res = 300,
|
|
extra_height = 0.4,
|
|
...
|
|
)
|
|
}
|
|
\arguments{
|
|
\item{ft}{A [flextable::flextable()] object, typically already styled with
|
|
[style_flextable_civilytics()].}
|
|
|
|
\item{path}{Character. Output PNG path. Returned invisibly.}
|
|
|
|
\item{logo}{Logical. Stamp the Civilytics logo onto the saved PNG via
|
|
[stamp_logo_png()]. Default `TRUE`.}
|
|
|
|
\item{res}{Numeric. Output resolution in PPI passed to [ragg::agg_png()].
|
|
Default `300`.}
|
|
|
|
\item{extra_height}{Numeric. Additional height in inches added to the
|
|
table's natural height to leave room for the stamped logo. Default `0.4`.}
|
|
|
|
\item{...}{Additional arguments forwarded to [stamp_logo_png()] (e.g.
|
|
`type`, `variant`, `position`, `width_frac`, `margin_frac`).}
|
|
}
|
|
\value{
|
|
`path`, invisibly.
|
|
}
|
|
\description{
|
|
Exports a styled [flextable::flextable()] to a PNG via
|
|
[ragg::agg_png()] (sized to the table's own dimensions plus a little
|
|
headroom for the logo), then optionally stamps the Civilytics logo onto the
|
|
file with [stamp_logo_png()] so file-based tables stay visually consistent
|
|
with [civilytics_logo()]-branded plots.
|
|
}
|
|
\details{
|
|
`ragg` and `flextable` are Suggested (not Imported); this function errors
|
|
with an install hint if either is unavailable.
|
|
}
|
|
\examples{
|
|
\dontrun{
|
|
library(flextable)
|
|
ft <- flextable(head(mtcars)) |>
|
|
add_footer_lines("Source: mtcars") |>
|
|
style_flextable_civilytics()
|
|
save_branded_flextable_png(ft, "table.png")
|
|
save_branded_flextable_png(ft, "table.png", position = "bottom-left")
|
|
knitr::include_graphics("table.png")
|
|
}
|
|
}
|
|
\seealso{
|
|
[style_flextable_civilytics()] to apply the brand styling, and
|
|
[stamp_logo_png()] for the underlying logo compositing.
|
|
}
|