Compare commits
12
Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
967e7e1111 | ||
|
|
f32093c662 | ||
|
|
e257180f15 | ||
|
|
0ef0f310e2 | ||
|
|
4fb5c488f8
|
||
|
|
96dc1c4c6b | ||
|
|
6ea9265236 | ||
|
|
b9d427eb76
|
||
|
|
a904d2313a
|
||
|
|
761a72da18 | ||
|
|
4f51a49903
|
||
|
|
5fc8155965
|
+5
-2
@@ -1,7 +1,7 @@
|
|||||||
Package: civilytics
|
Package: civilytics
|
||||||
Type: Package
|
Type: Package
|
||||||
Title: Brand Themes, Color Palettes, and Utility Functions for Civilytics
|
Title: Brand Themes, Color Palettes, and Utility Functions for Civilytics
|
||||||
Version: 0.2.0
|
Version: 0.3.1
|
||||||
Authors@R:
|
Authors@R:
|
||||||
person("Jared", "E. Knowles", email = "jared@civilytics.com",
|
person("Jared", "E. Knowles", email = "jared@civilytics.com",
|
||||||
role = c("aut", "cre"))
|
role = c("aut", "cre"))
|
||||||
@@ -31,7 +31,10 @@ Encoding: UTF-8
|
|||||||
Suggests:
|
Suggests:
|
||||||
testthat (>= 3.0.0),
|
testthat (>= 3.0.0),
|
||||||
tidycensus,
|
tidycensus,
|
||||||
quarto
|
quarto,
|
||||||
|
flextable,
|
||||||
|
officer,
|
||||||
|
ragg
|
||||||
Config/testthat/edition: 3
|
Config/testthat/edition: 3
|
||||||
Config/roxygen2/version: 8.0.0
|
Config/roxygen2/version: 8.0.0
|
||||||
RoxygenNote: 7.3.3
|
RoxygenNote: 7.3.3
|
||||||
|
|||||||
@@ -39,10 +39,13 @@ export(rnh)
|
|||||||
export(round_to_nearest_half)
|
export(round_to_nearest_half)
|
||||||
export(safe_max)
|
export(safe_max)
|
||||||
export(safe_ratio)
|
export(safe_ratio)
|
||||||
|
export(save_branded_flextable_png)
|
||||||
export(scale_color_civilytics)
|
export(scale_color_civilytics)
|
||||||
export(scale_fill_civilytics)
|
export(scale_fill_civilytics)
|
||||||
export(simpleCap)
|
export(simpleCap)
|
||||||
|
export(stamp_logo_png)
|
||||||
export(star_subs)
|
export(star_subs)
|
||||||
|
export(style_flextable_civilytics)
|
||||||
export(theme_civilytics)
|
export(theme_civilytics)
|
||||||
export(theme_civilytics_dark)
|
export(theme_civilytics_dark)
|
||||||
export(theme_civilytics_dark_map)
|
export(theme_civilytics_dark_map)
|
||||||
@@ -61,8 +64,12 @@ importFrom(ggplot2,annotation_custom)
|
|||||||
importFrom(ggplot2,ggplot)
|
importFrom(ggplot2,ggplot)
|
||||||
importFrom(ggplot2,theme)
|
importFrom(ggplot2,theme)
|
||||||
importFrom(ggplot2,theme_void)
|
importFrom(ggplot2,theme_void)
|
||||||
|
importFrom(grDevices,dev.off)
|
||||||
|
importFrom(grDevices,png)
|
||||||
importFrom(graphics,rasterImage)
|
importFrom(graphics,rasterImage)
|
||||||
importFrom(grid,grid.draw)
|
importFrom(grid,grid.draw)
|
||||||
|
importFrom(grid,grid.newpage)
|
||||||
|
importFrom(grid,grid.raster)
|
||||||
importFrom(grid,rasterGrob)
|
importFrom(grid,rasterGrob)
|
||||||
importFrom(gridExtra,arrangeGrob)
|
importFrom(gridExtra,arrangeGrob)
|
||||||
importFrom(jpeg,readJPEG)
|
importFrom(jpeg,readJPEG)
|
||||||
|
|||||||
+175
@@ -0,0 +1,175 @@
|
|||||||
|
#' Apply the Civilytics brand styling to a flextable
|
||||||
|
#'
|
||||||
|
#' Applies *only* the visual Civilytics brand to an already-structured
|
||||||
|
#' [flextable::flextable()] — header fill and color, body font and size,
|
||||||
|
#' zebra striping, borders, footer styling, and a fixed table layout. The
|
||||||
|
#' caller remains responsible for table *structure*: labels
|
||||||
|
#' ([flextable::set_header_labels()]), header/title lines
|
||||||
|
#' ([flextable::add_header_lines()]), column widths ([flextable::width()]),
|
||||||
|
#' alignment ([flextable::align()]), and footer text
|
||||||
|
#' ([flextable::add_footer_lines()]). This separation keeps styling reusable
|
||||||
|
#' across projects while leaving content decisions where they belong.
|
||||||
|
#'
|
||||||
|
#' `flextable`, `officer`, and `ragg` are Suggested (not Imported) to keep the
|
||||||
|
#' base install light, so this function errors with an install hint if
|
||||||
|
#' `flextable` is unavailable.
|
||||||
|
#'
|
||||||
|
#' @param ft A [flextable::flextable()] object.
|
||||||
|
#' @param header_bg Character. Header background fill. Default `"#2c3e50"`.
|
||||||
|
#' @param header_color Character. Header text color. Default `"white"`.
|
||||||
|
#' @param title_fontsize Numeric. Font size for the first header line (the
|
||||||
|
#' title row, `i = 1`). Default `14`.
|
||||||
|
#' @param body_fontsize Numeric. Body font size. Default `11`.
|
||||||
|
#' @param font_name Character. Font family applied to all parts. Default
|
||||||
|
#' `"Arial"`.
|
||||||
|
#' @param zebra Logical. Apply alternating-row striping to even body rows.
|
||||||
|
#' Default `TRUE`. Safely skipped for tables with fewer than two body rows.
|
||||||
|
#' @param zebra_bg Character. Fill color for striped (even) body rows.
|
||||||
|
#' Default `"#f0f0eb"`.
|
||||||
|
#' @param outer_border_color Character. Outer border color. Default
|
||||||
|
#' `"#888888"`.
|
||||||
|
#' @param outer_border_width Numeric. Outer border width. Default `1`.
|
||||||
|
#' @param inner_border_color Character. Inner horizontal border color (body).
|
||||||
|
#' Default `"#cccccc"`.
|
||||||
|
#' @param inner_border_width Numeric. Inner horizontal border width. Default
|
||||||
|
#' `0.5`.
|
||||||
|
#' @param footer_fontsize Numeric. Footer font size (applied only if a footer
|
||||||
|
#' part exists). Default `9`.
|
||||||
|
#' @param footer_color Character. Footer text color. Default `"#555555"`.
|
||||||
|
#'
|
||||||
|
#' @return The styled [flextable::flextable()] object.
|
||||||
|
#' @export
|
||||||
|
#' @seealso [save_branded_flextable_png()] to export the styled table to a
|
||||||
|
#' logo-stamped PNG.
|
||||||
|
#' @examples
|
||||||
|
#' \dontrun{
|
||||||
|
#' library(flextable)
|
||||||
|
#' ft <- flextable(head(mtcars)) |>
|
||||||
|
#' add_header_lines("Motor Trend Cars") |>
|
||||||
|
#' add_footer_lines("Source: mtcars") |>
|
||||||
|
#' style_flextable_civilytics()
|
||||||
|
#' }
|
||||||
|
style_flextable_civilytics <- function(ft,
|
||||||
|
header_bg = "#2c3e50",
|
||||||
|
header_color = "white",
|
||||||
|
title_fontsize = 14,
|
||||||
|
body_fontsize = 11,
|
||||||
|
font_name = "Arial",
|
||||||
|
zebra = TRUE,
|
||||||
|
zebra_bg = "#f0f0eb",
|
||||||
|
outer_border_color = "#888888",
|
||||||
|
outer_border_width = 1,
|
||||||
|
inner_border_color = "#cccccc",
|
||||||
|
inner_border_width = 0.5,
|
||||||
|
footer_fontsize = 9,
|
||||||
|
footer_color = "#555555") {
|
||||||
|
if (!requireNamespace("flextable", quietly = TRUE)) {
|
||||||
|
stop("Install 'flextable' to use this function.", call. = FALSE)
|
||||||
|
}
|
||||||
|
if (!requireNamespace("officer", quietly = TRUE)) {
|
||||||
|
stop("Install 'officer' to use this function.", call. = FALSE)
|
||||||
|
}
|
||||||
|
|
||||||
|
# Header: navy fill, white bold text, larger title line.
|
||||||
|
ft <- flextable::bg(ft, bg = header_bg, part = "header")
|
||||||
|
ft <- flextable::color(ft, color = header_color, part = "header")
|
||||||
|
ft <- flextable::bold(ft, part = "header")
|
||||||
|
ft <- flextable::fontsize(ft, i = 1, size = title_fontsize, part = "header")
|
||||||
|
|
||||||
|
# Body: readable size, brand font across all parts.
|
||||||
|
ft <- flextable::fontsize(ft, size = body_fontsize, part = "body")
|
||||||
|
ft <- flextable::font(ft, fontname = font_name, part = "all")
|
||||||
|
|
||||||
|
# Zebra striping on even body rows, guarded for tables with < 2 rows.
|
||||||
|
nrow_body <- flextable::nrow_part(ft, part = "body")
|
||||||
|
if (zebra && nrow_body >= 2) {
|
||||||
|
ft <- flextable::bg(ft, i = seq(2, nrow_body, 2), bg = zebra_bg,
|
||||||
|
part = "body")
|
||||||
|
}
|
||||||
|
|
||||||
|
# Borders: outer frame on all parts, light horizontal rules in the body.
|
||||||
|
ft <- flextable::border_outer(
|
||||||
|
ft,
|
||||||
|
border = officer::fp_border(color = outer_border_color,
|
||||||
|
width = outer_border_width),
|
||||||
|
part = "all"
|
||||||
|
)
|
||||||
|
ft <- flextable::border_inner_h(
|
||||||
|
ft,
|
||||||
|
border = officer::fp_border(color = inner_border_color,
|
||||||
|
width = inner_border_width),
|
||||||
|
part = "body"
|
||||||
|
)
|
||||||
|
|
||||||
|
# Footer styling — only if the table actually has a footer part.
|
||||||
|
if (flextable::nrow_part(ft, part = "footer") > 0) {
|
||||||
|
ft <- flextable::fontsize(ft, size = footer_fontsize, part = "footer")
|
||||||
|
ft <- flextable::color(ft, color = footer_color, part = "footer")
|
||||||
|
}
|
||||||
|
|
||||||
|
flextable::set_table_properties(ft, layout = "fixed")
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
#' Save a branded flextable to a logo-stamped PNG
|
||||||
|
#'
|
||||||
|
#' 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.
|
||||||
|
#'
|
||||||
|
#' `ragg` and `flextable` are Suggested (not Imported); this function errors
|
||||||
|
#' with an install hint if either is unavailable.
|
||||||
|
#'
|
||||||
|
#' @param ft A [flextable::flextable()] object, typically already styled with
|
||||||
|
#' [style_flextable_civilytics()].
|
||||||
|
#' @param path Character. Output PNG path. Returned invisibly.
|
||||||
|
#' @param logo Logical. Stamp the Civilytics logo onto the saved PNG via
|
||||||
|
#' [stamp_logo_png()]. Default `TRUE`.
|
||||||
|
#' @param res Numeric. Output resolution in PPI passed to [ragg::agg_png()].
|
||||||
|
#' Default `300`.
|
||||||
|
#' @param extra_height Numeric. Additional height in inches added to the
|
||||||
|
#' table's natural height to leave room for the stamped logo. Default `0.4`.
|
||||||
|
#' @param ... Additional arguments forwarded to [stamp_logo_png()] (e.g.
|
||||||
|
#' `type`, `variant`, `position`, `width_frac`, `margin_frac`).
|
||||||
|
#'
|
||||||
|
#' @return `path`, invisibly.
|
||||||
|
#' @export
|
||||||
|
#' @seealso [style_flextable_civilytics()] to apply the brand styling, and
|
||||||
|
#' [stamp_logo_png()] for the underlying logo compositing.
|
||||||
|
#' @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")
|
||||||
|
#' }
|
||||||
|
save_branded_flextable_png <- function(ft, path, logo = TRUE, res = 300,
|
||||||
|
extra_height = 0.4, ...) {
|
||||||
|
if (!requireNamespace("flextable", quietly = TRUE)) {
|
||||||
|
stop("Install 'flextable' to use this function.", call. = FALSE)
|
||||||
|
}
|
||||||
|
if (!requireNamespace("ragg", quietly = TRUE)) {
|
||||||
|
stop("Install 'ragg' to use this function.", call. = FALSE)
|
||||||
|
}
|
||||||
|
|
||||||
|
d <- flextable::flextable_dim(ft)
|
||||||
|
ragg::agg_png(path, width = d$width, height = d$height + extra_height,
|
||||||
|
units = "in", res = res)
|
||||||
|
on.exit(grDevices::dev.off(), add = TRUE)
|
||||||
|
plot(ft)
|
||||||
|
|
||||||
|
if (logo) {
|
||||||
|
# dev.off() must run before stamp_logo_png() re-reads the file. Flush the
|
||||||
|
# device now and clear the on.exit handler so it does not fire twice.
|
||||||
|
grDevices::dev.off()
|
||||||
|
on.exit()
|
||||||
|
stamp_logo_png(path, ...)
|
||||||
|
}
|
||||||
|
|
||||||
|
invisible(path)
|
||||||
|
}
|
||||||
@@ -5,32 +5,45 @@ CV_FONT_SANS <- "Inter" # axis text, legends, UI elements
|
|||||||
CV_FONT_SERIF <- "Source Serif 4" # body prose / editorial long-form
|
CV_FONT_SERIF <- "Source Serif 4" # body prose / editorial long-form
|
||||||
CV_FONT_MONO <- "JetBrains Mono" # code, data tables, numeric callouts
|
CV_FONT_MONO <- "JetBrains Mono" # code, data tables, numeric callouts
|
||||||
|
|
||||||
# Internal flag so civilytics_load_fonts() is idempotent within a session.
|
# Mutable package state held in an environment so the binding itself stays
|
||||||
.cv_fonts_loaded <- FALSE
|
# locked (R locks all namespace bindings at load time) while the contents
|
||||||
|
# remain writable. See https://adv-r.hadley.nz/environments.html#environments-as-containers
|
||||||
|
.cv_state <- new.env(parent = emptyenv())
|
||||||
|
.cv_state$fonts_loaded <- FALSE
|
||||||
|
|
||||||
#' Load Civilytics brand fonts
|
#' Load Civilytics brand fonts
|
||||||
#'
|
#'
|
||||||
#' Downloads Inter and Libre Franklin from Google Fonts via
|
#' Downloads Inter, Libre Franklin, Source Serif 4 and JetBrains Mono from
|
||||||
#' [sysfonts::font_add_google()], then calls [showtext::showtext_auto()] so
|
#' Google Fonts via [sysfonts::font_add_google()], then calls
|
||||||
#' that all graphics devices render text with those fonts. This is called
|
#' [showtext::showtext_auto()] so that all graphics devices render text with
|
||||||
#' automatically when the package loads; use this function to retry if the
|
#' those fonts. This is called automatically when the package loads; use this
|
||||||
#' initial load failed (e.g., the machine was offline at load time).
|
#' function to retry if the initial load failed (e.g., the machine was offline
|
||||||
|
#' at load time).
|
||||||
#'
|
#'
|
||||||
#' @return Invisibly returns `NULL`.
|
#' Subsequent calls within the same session are no-ops unless `force = TRUE`.
|
||||||
|
#'
|
||||||
|
#' @param force Logical. If `TRUE`, reload fonts even if they were already
|
||||||
|
#' loaded in this session. Default `FALSE`.
|
||||||
|
#'
|
||||||
|
#' @return Invisibly returns `TRUE` if fonts were loaded, `FALSE` if skipped
|
||||||
|
#' (already loaded and `force = FALSE`).
|
||||||
#' @export
|
#' @export
|
||||||
#'
|
#'
|
||||||
#' @examples
|
#' @examples
|
||||||
#' \dontrun{
|
#' \dontrun{
|
||||||
#' civilytics_load_fonts()
|
#' civilytics_load_fonts()
|
||||||
#' }
|
#' }
|
||||||
civilytics_load_fonts <- function() {
|
civilytics_load_fonts <- function(force = FALSE) {
|
||||||
|
if (.cv_state$fonts_loaded && !force) return(invisible(FALSE))
|
||||||
|
|
||||||
sysfonts::font_add_google("Inter", family = "Inter")
|
sysfonts::font_add_google("Inter", family = "Inter")
|
||||||
sysfonts::font_add_google("Libre Franklin", family = "Libre Franklin")
|
sysfonts::font_add_google("Libre Franklin", family = "Libre Franklin")
|
||||||
sysfonts::font_add_google("Source Serif 4", family = "Source Serif 4")
|
sysfonts::font_add_google("Source Serif 4", family = "Source Serif 4")
|
||||||
sysfonts::font_add_google("JetBrains Mono", family = "JetBrains Mono")
|
sysfonts::font_add_google("JetBrains Mono", family = "JetBrains Mono")
|
||||||
showtext::showtext_auto()
|
showtext::showtext_auto()
|
||||||
.cv_fonts_loaded <<- TRUE
|
|
||||||
invisible(NULL)
|
.cv_state$fonts_loaded <- TRUE
|
||||||
|
invisible(TRUE)
|
||||||
}
|
}
|
||||||
|
|
||||||
.onLoad <- function(libname, pkgname) {
|
.onLoad <- function(libname, pkgname) {
|
||||||
|
|||||||
@@ -361,3 +361,92 @@ civilytics_logo <- function(plot,
|
|||||||
position = position)
|
position = position)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
||||||
|
#' Stamp the Civilytics logo onto a saved raster (PNG) image
|
||||||
|
#'
|
||||||
|
#' The raster analogue of [civilytics_logo()] for outputs that are already
|
||||||
|
#' rendered to a file rather than held as a ggplot/grob — e.g. a `flextable`
|
||||||
|
#' exported to PNG, or any `grDevices::png()` / `ragg::agg_png()` output.
|
||||||
|
#' Resolves the *same* brand asset that [make_logo_grob()] uses, so file-based
|
||||||
|
#' tables stay visually consistent with logo-branded plots, and composites it
|
||||||
|
#' into a corner of the image. Pure base-graphics + grid + png — no new
|
||||||
|
#' package dependencies.
|
||||||
|
#'
|
||||||
|
#' @param path Character. Path to the PNG to stamp. The file is overwritten
|
||||||
|
#' in place at its original pixel dimensions.
|
||||||
|
#' @param type Character. `"wordmark"` (default) or `"mark"`. As in
|
||||||
|
#' [make_logo_grob()].
|
||||||
|
#' @param variant Character. `"light"` (default, dark logo for light
|
||||||
|
#' backgrounds) or `"dark"` (reverse logo for dark backgrounds).
|
||||||
|
#' @param position Character. Corner placement: `"bottom-right"` (default),
|
||||||
|
#' `"bottom-left"`, `"top-right"`, or `"top-left"`.
|
||||||
|
#' @param width_frac Numeric. Logo width as a fraction of the image width
|
||||||
|
#' (default `0.15`). Height follows from the logo's aspect ratio.
|
||||||
|
#' @param margin_frac Numeric. Padding from the edges as a fraction of the
|
||||||
|
#' image width (default `0.02`).
|
||||||
|
#'
|
||||||
|
#' @return `path`, invisibly.
|
||||||
|
#' @export
|
||||||
|
#' @importFrom png readPNG
|
||||||
|
#' @importFrom grid grid.newpage grid.raster
|
||||||
|
#' @importFrom grDevices png dev.off
|
||||||
|
#' @examples
|
||||||
|
#' \dontrun{
|
||||||
|
#' # Brand a table exported to PNG so it matches civilytics_logo()-branded plots
|
||||||
|
#' ragg::agg_png("table.png", width = 8, height = 4, units = "in", res = 200)
|
||||||
|
#' plot(flextable::flextable(head(mtcars)))
|
||||||
|
#' dev.off()
|
||||||
|
#' stamp_logo_png("table.png") # wordmark, bottom-right
|
||||||
|
#' stamp_logo_png("table.png", type = "mark", position = "bottom-left")
|
||||||
|
#' }
|
||||||
|
stamp_logo_png <- function(path,
|
||||||
|
type = c("wordmark", "mark"),
|
||||||
|
variant = c("light", "dark"),
|
||||||
|
position = c("bottom-right", "bottom-left",
|
||||||
|
"top-right", "top-left"),
|
||||||
|
width_frac = 0.15,
|
||||||
|
margin_frac = 0.02) {
|
||||||
|
type <- match.arg(type)
|
||||||
|
variant <- match.arg(variant)
|
||||||
|
position <- match.arg(position)
|
||||||
|
stopifnot(file.exists(path))
|
||||||
|
|
||||||
|
# Same asset selection as make_logo_grob() so files match branded plots.
|
||||||
|
img_file <- switch(
|
||||||
|
paste(type, variant, sep = "_"),
|
||||||
|
wordmark_light = "civilytics-wordmark.png",
|
||||||
|
wordmark_dark = "civilytics-wordmark-reverse.png",
|
||||||
|
mark_light = "civilytics-mark.png",
|
||||||
|
mark_dark = "civilytics-mark-reverse.png"
|
||||||
|
)
|
||||||
|
logo_path <- system.file("img", img_file, package = "civilytics")
|
||||||
|
if (!nzchar(logo_path)) {
|
||||||
|
stop("Civilytics logo asset not found in the 'civilytics' package: ", img_file)
|
||||||
|
}
|
||||||
|
|
||||||
|
base_img <- png::readPNG(path) # height x width x channels, values in [0, 1]
|
||||||
|
logo_img <- png::readPNG(logo_path)
|
||||||
|
h <- dim(base_img)[1]
|
||||||
|
w <- dim(base_img)[2]
|
||||||
|
aspect <- dim(logo_img)[1] / dim(logo_img)[2] # logo height / width
|
||||||
|
|
||||||
|
# Sizes/margins are expressed relative to image WIDTH, then converted to the
|
||||||
|
# device's npc units (which scale with the viewport's own width and height).
|
||||||
|
lw <- width_frac
|
||||||
|
lh <- width_frac * aspect * (w / h)
|
||||||
|
mx <- margin_frac
|
||||||
|
my <- margin_frac * (w / h)
|
||||||
|
|
||||||
|
x <- if (grepl("right", position)) 1 - mx else mx
|
||||||
|
y <- if (grepl("top", position)) 1 - my else my
|
||||||
|
just <- c(if (grepl("right", position)) "right" else "left",
|
||||||
|
if (grepl("top", position)) "top" else "bottom")
|
||||||
|
|
||||||
|
grDevices::png(path, width = w, height = h, units = "px")
|
||||||
|
on.exit(grDevices::dev.off(), add = TRUE)
|
||||||
|
grid::grid.newpage()
|
||||||
|
grid::grid.raster(base_img, width = 1, height = 1, interpolate = FALSE)
|
||||||
|
grid::grid.raster(logo_img, x = x, y = y, width = lw, height = lh,
|
||||||
|
just = just, interpolate = TRUE)
|
||||||
|
invisible(path)
|
||||||
|
}
|
||||||
|
|||||||
+9
-7
@@ -135,12 +135,12 @@ use_civilytics_theme <- function(path = ".", force = FALSE) {
|
|||||||
.copy_pkg_file(file.path("quarto/latex", f), file.path("latex", f), path, force)
|
.copy_pkg_file(file.path("quarto/latex", f), file.path("latex", f), path, force)
|
||||||
}
|
}
|
||||||
|
|
||||||
# Typst
|
# Typst — shipped as template-partials so Quarto keeps its Skylighting
|
||||||
.copy_pkg_file(
|
# definitions and syntax-highlighted code blocks render (see issue #12)
|
||||||
"quarto/typst/civilytics-typst.typ",
|
typst_files <- c("typst-template.typ", "typst-show.typ")
|
||||||
"typst/civilytics-typst.typ",
|
for (f in typst_files) {
|
||||||
path, force
|
.copy_pkg_file(file.path("quarto/typst", f), file.path("typst", f), path, force)
|
||||||
)
|
}
|
||||||
|
|
||||||
# Logos — for _brand.yml (expects assets/logo/)
|
# Logos — for _brand.yml (expects assets/logo/)
|
||||||
.copy_logos("assets/logo", path, force)
|
.copy_logos("assets/logo", path, force)
|
||||||
@@ -158,7 +158,9 @@ use_civilytics_theme <- function(path = ".", force = FALSE) {
|
|||||||
message(" include-in-header: latex/civilytics.tex")
|
message(" include-in-header: latex/civilytics.tex")
|
||||||
message(" include-before-body: latex/civilytics-title.tex")
|
message(" include-before-body: latex/civilytics-title.tex")
|
||||||
message(" typst:")
|
message(" typst:")
|
||||||
message(" template: typst/civilytics-typst.typ")
|
message(" template-partials:")
|
||||||
|
message(" - typst/typst-template.typ")
|
||||||
|
message(" - typst/typst-show.typ")
|
||||||
message("---")
|
message("---")
|
||||||
message("\nSee examples/report.qmd for a complete example.")
|
message("\nSee examples/report.qmd for a complete example.")
|
||||||
invisible(NULL)
|
invisible(NULL)
|
||||||
|
|||||||
@@ -36,10 +36,12 @@
|
|||||||
#' to [civilytics_colors]`["paper_2"]` (`#F2EDE4`).
|
#' to [civilytics_colors]`["paper_2"]` (`#F2EDE4`).
|
||||||
#' @param grid Character. Which major gridlines to draw: `"y"` (default,
|
#' @param grid Character. Which major gridlines to draw: `"y"` (default,
|
||||||
#' horizontal only), `"x"` (vertical only), `"both"`, or `"none"`.
|
#' horizontal only), `"x"` (vertical only), `"both"`, or `"none"`.
|
||||||
#' @param paper_bg Logical. If `TRUE` (default), fill the plot and panel
|
#' @param paper_bg Logical. If `TRUE`, fill the plot and panel backgrounds
|
||||||
#' backgrounds with the warm `paper` color. Set to `FALSE` for a
|
#' with the warm `paper` color (Civilytics cream). Default is `FALSE`
|
||||||
#' transparent background (useful for slides or overlay on colored
|
#' (transparent) so that figures composite cleanly onto any background.
|
||||||
#' surfaces).
|
#' Set to `TRUE` for the branded cream canvas. Note: a transparent device
|
||||||
|
#' background (e.g., `dev = "ragg_png"`, `dev.args = list(background =
|
||||||
|
#' "transparent")`) is also needed for fully-transparent PNG exports.
|
||||||
#'
|
#'
|
||||||
#' @section Font size hierarchy:
|
#' @section Font size hierarchy:
|
||||||
#' All text sizes are derived from `font_size` using relative scale factors.
|
#' All text sizes are derived from `font_size` using relative scale factors.
|
||||||
@@ -68,7 +70,7 @@
|
|||||||
#' \dontrun{
|
#' \dontrun{
|
||||||
#' library(ggplot2)
|
#' library(ggplot2)
|
||||||
#'
|
#'
|
||||||
#' # Default editorial theme
|
#' # Default — transparent background for embedding
|
||||||
#' ggplot(mpg, aes(displ, hwy)) +
|
#' ggplot(mpg, aes(displ, hwy)) +
|
||||||
#' geom_point() +
|
#' geom_point() +
|
||||||
#' theme_civilytics()
|
#' theme_civilytics()
|
||||||
@@ -79,10 +81,10 @@
|
|||||||
#' scale_color_civilytics() +
|
#' scale_color_civilytics() +
|
||||||
#' theme_civilytics(grid = "both")
|
#' theme_civilytics(grid = "both")
|
||||||
#'
|
#'
|
||||||
#' # Transparent background for embedding
|
#' # Branded cream background (opt-in)
|
||||||
#' ggplot(mpg, aes(displ, hwy)) +
|
#' ggplot(mpg, aes(displ, hwy)) +
|
||||||
#' geom_point() +
|
#' geom_point() +
|
||||||
#' theme_civilytics(paper_bg = FALSE)
|
#' theme_civilytics(paper_bg = TRUE)
|
||||||
#'
|
#'
|
||||||
#' # Larger text for poster or display
|
#' # Larger text for poster or display
|
||||||
#' ggplot(mpg, aes(displ, hwy)) +
|
#' ggplot(mpg, aes(displ, hwy)) +
|
||||||
@@ -102,7 +104,7 @@ theme_civilytics <- function(
|
|||||||
accent = unname(civilytics_colors["ember_600"]),
|
accent = unname(civilytics_colors["ember_600"]),
|
||||||
strip_color = unname(civilytics_colors["paper_2"]),
|
strip_color = unname(civilytics_colors["paper_2"]),
|
||||||
grid = c("y", "x", "both", "none"),
|
grid = c("y", "x", "both", "none"),
|
||||||
paper_bg = TRUE) {
|
paper_bg = FALSE) {
|
||||||
|
|
||||||
grid <- match.arg(grid)
|
grid <- match.arg(grid)
|
||||||
half_line <- font_size / 2
|
half_line <- font_size / 2
|
||||||
|
|||||||
@@ -2,7 +2,7 @@
|
|||||||
title: "Who pays when rent outpaces wages?"
|
title: "Who pays when rent outpaces wages?"
|
||||||
subtitle: "A 12-county analysis of cost-burdened renter households, 2019–2024."
|
subtitle: "A 12-county analysis of cost-burdened renter households, 2019–2024."
|
||||||
author:
|
author:
|
||||||
- name: "Civilytics Research"
|
- name: "Jared Knowles"
|
||||||
affiliation: "Civilytics Consulting"
|
affiliation: "Civilytics Consulting"
|
||||||
date: "2026-04-15"
|
date: "2026-04-15"
|
||||||
abstract: |
|
abstract: |
|
||||||
@@ -19,7 +19,9 @@ format:
|
|||||||
toc: true
|
toc: true
|
||||||
toc-location: right
|
toc-location: right
|
||||||
typst:
|
typst:
|
||||||
template: ../typst/civilytics-typst.typ
|
template-partials:
|
||||||
|
- ../typst/typst-template.typ
|
||||||
|
- ../typst/typst-show.typ
|
||||||
pdf:
|
pdf:
|
||||||
include-in-header: ../latex/civilytics.tex
|
include-in-header: ../latex/civilytics.tex
|
||||||
include-before-body: ../latex/civilytics-title.tex
|
include-before-body: ../latex/civilytics-title.tex
|
||||||
|
|||||||
@@ -55,11 +55,11 @@ Big idea goes here.
|
|||||||
|
|
||||||
> Rent has outpaced wages in every county we studied.
|
> Rent has outpaced wages in every county we studied.
|
||||||
|
|
||||||
Civilytics Research, 2026
|
Civilytics Consulting, 2026
|
||||||
|
|
||||||
## Thank you {.thank-you}
|
## Thank you {.thank-you}
|
||||||
|
|
||||||
Questions?
|
Questions?
|
||||||
|
|
||||||
- jared@civilytics.com
|
- jared@civilytics.com
|
||||||
- civilytics.consulting
|
- civilytics.com
|
||||||
|
|||||||
@@ -2,11 +2,16 @@
|
|||||||
% Replaces Quarto's default \maketitle. Uses values from YAML
|
% Replaces Quarto's default \maketitle. Uses values from YAML
|
||||||
% (\thetitle, \theauthor, \thedate) plus an \ifabstract block.
|
% (\thetitle, \theauthor, \thedate) plus an \ifabstract block.
|
||||||
|
|
||||||
|
% Guard: \thesubtitle is normally defined by civilytics.tex's subtitle
|
||||||
|
% capture; provide a fallback so this partial degrades gracefully if used
|
||||||
|
% without that preamble. See civilyticsR issue #13.
|
||||||
|
\providecommand{\thesubtitle}{}
|
||||||
|
|
||||||
\begin{titlepage}
|
\begin{titlepage}
|
||||||
\pagecolor{paper}
|
\pagecolor{paper}
|
||||||
\color{ink}
|
\color{ink}
|
||||||
\vspace*{0.5in}
|
\vspace*{0.5in}
|
||||||
{\sffamily\bfseries\scriptsize\color{ember}\MakeUppercase{— Civilytics Research}\par}
|
{\sffamily\bfseries\scriptsize\color{ember}\MakeUppercase{— Civilytics Consulting}\par}
|
||||||
\vspace{12pt}
|
\vspace{12pt}
|
||||||
{\displayfont\fontsize{32pt}{34pt}\selectfont\bfseries\color{ink}\thetitle\par}
|
{\displayfont\fontsize{32pt}{34pt}\selectfont\bfseries\color{ink}\thetitle\par}
|
||||||
\vspace{8pt}
|
\vspace{8pt}
|
||||||
@@ -33,8 +38,6 @@
|
|||||||
|
|
||||||
% Pulse mark, in ember
|
% Pulse mark, in ember
|
||||||
\begin{center}
|
\begin{center}
|
||||||
\begin{tikzpicture}[overlay, remember picture]
|
|
||||||
\end{tikzpicture}
|
|
||||||
{\color{ember}\rule{40pt}{2pt}}
|
{\color{ember}\rule{40pt}{2pt}}
|
||||||
\end{center}
|
\end{center}
|
||||||
\end{titlepage}
|
\end{titlepage}
|
||||||
|
|||||||
@@ -40,17 +40,40 @@
|
|||||||
\color{ink}
|
\color{ink}
|
||||||
|
|
||||||
% --- Fonts (require local install or fontspec lookup) ---
|
% --- Fonts (require local install or fontspec lookup) ---
|
||||||
|
% Bold uses the family's native Bold weight (present in every Source Serif 4
|
||||||
|
% install). Do NOT hard-require a "SemiBold" face: the package installs no
|
||||||
|
% system fonts for the PDF path, and standard Source Serif 4 ships only
|
||||||
|
% Regular/Bold/Italic/BoldItalic. See civilyticsR issue #14.
|
||||||
\setmainfont{Source Serif 4}[
|
\setmainfont{Source Serif 4}[
|
||||||
UprightFont = *,
|
UprightFont = *,
|
||||||
ItalicFont = * Italic,
|
ItalicFont = * Italic,
|
||||||
BoldFont = * SemiBold,
|
|
||||||
BoldItalicFont = * SemiBold Italic,
|
|
||||||
Ligatures = TeX,
|
Ligatures = TeX,
|
||||||
]
|
]
|
||||||
\setsansfont{Inter}[Ligatures = TeX]
|
\setsansfont{Inter}[Ligatures = TeX]
|
||||||
\setmonofont{JetBrains Mono}[Scale = 0.92]
|
\setmonofont{JetBrains Mono}[Scale = 0.92]
|
||||||
\newfontfamily\displayfont{Libre Franklin}[Ligatures = TeX]
|
\newfontfamily\displayfont{Libre Franklin}[Ligatures = TeX]
|
||||||
|
|
||||||
|
% --- Subtitle capture ---
|
||||||
|
% Quarto/pandoc defines \subtitle (which appends to \@title) but never
|
||||||
|
% \thesubtitle, which the title page uses. This preamble is emitted before
|
||||||
|
% pandoc's \providecommand{\subtitle}, so our definition wins: capture the
|
||||||
|
% subtitle into \thesubtitle instead. See civilyticsR issue #13.
|
||||||
|
\makeatletter
|
||||||
|
\providecommand{\thesubtitle}{}
|
||||||
|
\def\subtitle#1{\renewcommand{\thesubtitle}{#1}}
|
||||||
|
\makeatother
|
||||||
|
|
||||||
|
% --- Use the Civilytics title page, not pandoc's default ---
|
||||||
|
% civilytics-title.tex (include-before-body) IS the title page. Quarto emits
|
||||||
|
% its default \maketitle + abstract *before* include-before-body, which would
|
||||||
|
% print a second, unstyled title. Neutralise both here, in the preamble
|
||||||
|
% (runs at \begin{document}, before the default title). The branded title page
|
||||||
|
% does not display the abstract. See civilyticsR issue #13.
|
||||||
|
\AtBeginDocument{%
|
||||||
|
\renewcommand{\maketitle}{}%
|
||||||
|
\renewenvironment{abstract}{\setbox0=\vbox\bgroup}{\egroup}%
|
||||||
|
}
|
||||||
|
|
||||||
% --- Hyperlinks ---
|
% --- Hyperlinks ---
|
||||||
\hypersetup{
|
\hypersetup{
|
||||||
colorlinks = true,
|
colorlinks = true,
|
||||||
@@ -77,7 +100,7 @@
|
|||||||
\renewcommand{\footrulewidth}{0pt}
|
\renewcommand{\footrulewidth}{0pt}
|
||||||
\fancyhead[L]{\sffamily\scriptsize\color{ink3}\MakeUppercase{Civilytics Consulting}}
|
\fancyhead[L]{\sffamily\scriptsize\color{ink3}\MakeUppercase{Civilytics Consulting}}
|
||||||
\fancyhead[R]{\sffamily\scriptsize\color{ink3}\thetitle}
|
\fancyhead[R]{\sffamily\scriptsize\color{ink3}\thetitle}
|
||||||
\fancyfoot[L]{\sffamily\scriptsize\color{ink3}civilytics.consulting}
|
\fancyfoot[L]{\sffamily\scriptsize\color{ink3}civilytics.com}
|
||||||
\fancyfoot[C]{\sffamily\scriptsize\color{ink3}\thepage}
|
\fancyfoot[C]{\sffamily\scriptsize\color{ink3}\thepage}
|
||||||
\fancyfoot[R]{\sffamily\scriptsize\color{ink3}\textcopyright\ 2026}
|
\fancyfoot[R]{\sffamily\scriptsize\color{ink3}\textcopyright\ 2026}
|
||||||
|
|
||||||
|
|||||||
@@ -0,0 +1,17 @@
|
|||||||
|
// Civilytics — Typst show/entry partial for Quarto (typst-show.typ).
|
||||||
|
// Pairs with typst-template.typ. Quarto appends the rendered document body
|
||||||
|
// after this partial, so this file intentionally ends with the show rule and
|
||||||
|
// no trailing body token. (Do not write that token in a comment here: Quarto
|
||||||
|
// interpolates its template variables even inside comments.)
|
||||||
|
// Title/subtitle/date are wrapped in [ ] so arbitrary text (including words
|
||||||
|
// that are Typst keywords like "for"/"in") is treated as content, not code.
|
||||||
|
// See civilyticsR issue #12.
|
||||||
|
#show: doc => civilytics(
|
||||||
|
title: [$title$],
|
||||||
|
$if(subtitle)$subtitle: [$subtitle$],$endif$
|
||||||
|
$if(by-author)$authors: ($for(by-author)$"$it.name.literal$",$endfor$),$endif$
|
||||||
|
$if(date)$date: [$date$],$endif$
|
||||||
|
$if(abstract)$abstract: [$abstract$],$endif$
|
||||||
|
toc: $if(toc)$true$else$false$endif$,
|
||||||
|
doc
|
||||||
|
)
|
||||||
@@ -1,9 +1,15 @@
|
|||||||
// =============================================================
|
// =============================================================
|
||||||
// Civilytics — Typst template for Quarto PDF
|
// Civilytics — Typst template partial for Quarto PDF (typst-template.typ).
|
||||||
|
// Shipped as a Quarto template-partial (paired with typst-show.typ) rather
|
||||||
|
// than a full `template:` so Quarto keeps its own `definitions` partial —
|
||||||
|
// which defines Skylighting/token functions needed for syntax-highlighted
|
||||||
|
// code blocks. See civilyticsR issue #12.
|
||||||
// Usage in YAML:
|
// Usage in YAML:
|
||||||
// format:
|
// format:
|
||||||
// typst:
|
// typst:
|
||||||
// template: quarto/typst/civilytics-typst.typ
|
// template-partials:
|
||||||
|
// - quarto/typst/typst-template.typ
|
||||||
|
// - quarto/typst/typst-show.typ
|
||||||
// =============================================================
|
// =============================================================
|
||||||
|
|
||||||
#let paper-bg = rgb("#FAF7F2")
|
#let paper-bg = rgb("#FAF7F2")
|
||||||
@@ -54,7 +60,7 @@
|
|||||||
grid(
|
grid(
|
||||||
columns: (1fr, auto, 1fr),
|
columns: (1fr, auto, 1fr),
|
||||||
align: (left, center, right),
|
align: (left, center, right),
|
||||||
[civilytics.consulting],
|
[civilytics.com],
|
||||||
counter(page).display("1 / 1", both: true),
|
counter(page).display("1 / 1", both: true),
|
||||||
[© 2026]
|
[© 2026]
|
||||||
)
|
)
|
||||||
@@ -158,7 +164,7 @@
|
|||||||
if title != none {
|
if title != none {
|
||||||
block[
|
block[
|
||||||
#set text(font: sans-stack, size: 8pt, weight: 600, fill: ember, tracking: 0.1em)
|
#set text(font: sans-stack, size: 8pt, weight: 600, fill: ember, tracking: 0.1em)
|
||||||
#upper[— Civilytics Research]
|
#upper[— Civilytics Consulting]
|
||||||
]
|
]
|
||||||
v(8pt)
|
v(8pt)
|
||||||
block[
|
block[
|
||||||
@@ -229,16 +235,3 @@
|
|||||||
|
|
||||||
doc
|
doc
|
||||||
}
|
}
|
||||||
|
|
||||||
// Quarto entry point
|
|
||||||
#show: doc => civilytics(
|
|
||||||
title: $title$,
|
|
||||||
$if(subtitle)$subtitle: $subtitle$,$endif$
|
|
||||||
$if(by-author)$authors: ($for(by-author)$"$it.name.literal$",$endfor$),$endif$
|
|
||||||
$if(date)$date: $date$,$endif$
|
|
||||||
$if(abstract)$abstract: [$abstract$],$endif$
|
|
||||||
toc: $if(toc)$true$else$false$endif$,
|
|
||||||
doc
|
|
||||||
)
|
|
||||||
|
|
||||||
$body$
|
|
||||||
@@ -4,17 +4,25 @@
|
|||||||
\alias{civilytics_load_fonts}
|
\alias{civilytics_load_fonts}
|
||||||
\title{Load Civilytics brand fonts}
|
\title{Load Civilytics brand fonts}
|
||||||
\usage{
|
\usage{
|
||||||
civilytics_load_fonts()
|
civilytics_load_fonts(force = FALSE)
|
||||||
|
}
|
||||||
|
\arguments{
|
||||||
|
\item{force}{Logical. If \code{TRUE}, reload fonts even if they were already
|
||||||
|
loaded in this session. Default \code{FALSE}.}
|
||||||
}
|
}
|
||||||
\value{
|
\value{
|
||||||
Invisibly returns `NULL`.
|
Invisibly returns \code{TRUE} if fonts were loaded, \code{FALSE} if skipped
|
||||||
|
(already loaded and \code{force = FALSE}).
|
||||||
}
|
}
|
||||||
\description{
|
\description{
|
||||||
Downloads Inter and Libre Franklin from Google Fonts via
|
Downloads Inter, Libre Franklin, Source Serif 4 and JetBrains Mono from
|
||||||
[sysfonts::font_add_google()], then calls [showtext::showtext_auto()] so
|
Google Fonts via \code{sysfonts::font_add_google()}, then calls
|
||||||
that all graphics devices render text with those fonts. This is called
|
\code{showtext::showtext_auto()} so that all graphics devices render text with
|
||||||
automatically when the package loads; use this function to retry if the
|
those fonts. This is called automatically when the package loads; use this
|
||||||
initial load failed (e.g., the machine was offline at load time).
|
function to retry if the initial load failed (e.g., the machine was offline
|
||||||
|
at load time).
|
||||||
|
|
||||||
|
Subsequent calls within the same session are no-ops unless \code{force = TRUE}.
|
||||||
}
|
}
|
||||||
\examples{
|
\examples{
|
||||||
\dontrun{
|
\dontrun{
|
||||||
|
|||||||
@@ -0,0 +1,62 @@
|
|||||||
|
% 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.
|
||||||
|
}
|
||||||
@@ -0,0 +1,56 @@
|
|||||||
|
% Generated by roxygen2: do not edit by hand
|
||||||
|
% Please edit documentation in R/logo.R
|
||||||
|
\name{stamp_logo_png}
|
||||||
|
\alias{stamp_logo_png}
|
||||||
|
\title{Stamp the Civilytics logo onto a saved raster (PNG) image}
|
||||||
|
\usage{
|
||||||
|
stamp_logo_png(
|
||||||
|
path,
|
||||||
|
type = c("wordmark", "mark"),
|
||||||
|
variant = c("light", "dark"),
|
||||||
|
position = c("bottom-right", "bottom-left", "top-right", "top-left"),
|
||||||
|
width_frac = 0.15,
|
||||||
|
margin_frac = 0.02
|
||||||
|
)
|
||||||
|
}
|
||||||
|
\arguments{
|
||||||
|
\item{path}{Character. Path to the PNG to stamp. The file is overwritten
|
||||||
|
in place at its original pixel dimensions.}
|
||||||
|
|
||||||
|
\item{type}{Character. `"wordmark"` (default) or `"mark"`. As in
|
||||||
|
[make_logo_grob()].}
|
||||||
|
|
||||||
|
\item{variant}{Character. `"light"` (default, dark logo for light
|
||||||
|
backgrounds) or `"dark"` (reverse logo for dark backgrounds).}
|
||||||
|
|
||||||
|
\item{position}{Character. Corner placement: `"bottom-right"` (default),
|
||||||
|
`"bottom-left"`, `"top-right"`, or `"top-left"`.}
|
||||||
|
|
||||||
|
\item{width_frac}{Numeric. Logo width as a fraction of the image width
|
||||||
|
(default `0.15`). Height follows from the logo's aspect ratio.}
|
||||||
|
|
||||||
|
\item{margin_frac}{Numeric. Padding from the edges as a fraction of the
|
||||||
|
image width (default `0.02`).}
|
||||||
|
}
|
||||||
|
\value{
|
||||||
|
`path`, invisibly.
|
||||||
|
}
|
||||||
|
\description{
|
||||||
|
The raster analogue of [civilytics_logo()] for outputs that are already
|
||||||
|
rendered to a file rather than held as a ggplot/grob — e.g. a `flextable`
|
||||||
|
exported to PNG, or any `grDevices::png()` / `ragg::agg_png()` output.
|
||||||
|
Resolves the *same* brand asset that [make_logo_grob()] uses, so file-based
|
||||||
|
tables stay visually consistent with logo-branded plots, and composites it
|
||||||
|
into a corner of the image. Pure base-graphics + grid + png — no new
|
||||||
|
package dependencies.
|
||||||
|
}
|
||||||
|
\examples{
|
||||||
|
\dontrun{
|
||||||
|
# Brand a table exported to PNG so it matches civilytics_logo()-branded plots
|
||||||
|
ragg::agg_png("table.png", width = 8, height = 4, units = "in", res = 200)
|
||||||
|
plot(flextable::flextable(head(mtcars)))
|
||||||
|
dev.off()
|
||||||
|
stamp_logo_png("table.png") # wordmark, bottom-right
|
||||||
|
stamp_logo_png("table.png", type = "mark", position = "bottom-left")
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,92 @@
|
|||||||
|
% Generated by roxygen2: do not edit by hand
|
||||||
|
% Please edit documentation in R/flextable.R
|
||||||
|
\name{style_flextable_civilytics}
|
||||||
|
\alias{style_flextable_civilytics}
|
||||||
|
\title{Apply the Civilytics brand styling to a flextable}
|
||||||
|
\usage{
|
||||||
|
style_flextable_civilytics(
|
||||||
|
ft,
|
||||||
|
header_bg = "#2c3e50",
|
||||||
|
header_color = "white",
|
||||||
|
title_fontsize = 14,
|
||||||
|
body_fontsize = 11,
|
||||||
|
font_name = "Arial",
|
||||||
|
zebra = TRUE,
|
||||||
|
zebra_bg = "#f0f0eb",
|
||||||
|
outer_border_color = "#888888",
|
||||||
|
outer_border_width = 1,
|
||||||
|
inner_border_color = "#cccccc",
|
||||||
|
inner_border_width = 0.5,
|
||||||
|
footer_fontsize = 9,
|
||||||
|
footer_color = "#555555"
|
||||||
|
)
|
||||||
|
}
|
||||||
|
\arguments{
|
||||||
|
\item{ft}{A [flextable::flextable()] object.}
|
||||||
|
|
||||||
|
\item{header_bg}{Character. Header background fill. Default `"#2c3e50"`.}
|
||||||
|
|
||||||
|
\item{header_color}{Character. Header text color. Default `"white"`.}
|
||||||
|
|
||||||
|
\item{title_fontsize}{Numeric. Font size for the first header line (the
|
||||||
|
title row, `i = 1`). Default `14`.}
|
||||||
|
|
||||||
|
\item{body_fontsize}{Numeric. Body font size. Default `11`.}
|
||||||
|
|
||||||
|
\item{font_name}{Character. Font family applied to all parts. Default
|
||||||
|
`"Arial"`.}
|
||||||
|
|
||||||
|
\item{zebra}{Logical. Apply alternating-row striping to even body rows.
|
||||||
|
Default `TRUE`. Safely skipped for tables with fewer than two body rows.}
|
||||||
|
|
||||||
|
\item{zebra_bg}{Character. Fill color for striped (even) body rows.
|
||||||
|
Default `"#f0f0eb"`.}
|
||||||
|
|
||||||
|
\item{outer_border_color}{Character. Outer border color. Default
|
||||||
|
`"#888888"`.}
|
||||||
|
|
||||||
|
\item{outer_border_width}{Numeric. Outer border width. Default `1`.}
|
||||||
|
|
||||||
|
\item{inner_border_color}{Character. Inner horizontal border color (body).
|
||||||
|
Default `"#cccccc"`.}
|
||||||
|
|
||||||
|
\item{inner_border_width}{Numeric. Inner horizontal border width. Default
|
||||||
|
`0.5`.}
|
||||||
|
|
||||||
|
\item{footer_fontsize}{Numeric. Footer font size (applied only if a footer
|
||||||
|
part exists). Default `9`.}
|
||||||
|
|
||||||
|
\item{footer_color}{Character. Footer text color. Default `"#555555"`.}
|
||||||
|
}
|
||||||
|
\value{
|
||||||
|
The styled [flextable::flextable()] object.
|
||||||
|
}
|
||||||
|
\description{
|
||||||
|
Applies *only* the visual Civilytics brand to an already-structured
|
||||||
|
[flextable::flextable()] — header fill and color, body font and size,
|
||||||
|
zebra striping, borders, footer styling, and a fixed table layout. The
|
||||||
|
caller remains responsible for table *structure*: labels
|
||||||
|
([flextable::set_header_labels()]), header/title lines
|
||||||
|
([flextable::add_header_lines()]), column widths ([flextable::width()]),
|
||||||
|
alignment ([flextable::align()]), and footer text
|
||||||
|
([flextable::add_footer_lines()]). This separation keeps styling reusable
|
||||||
|
across projects while leaving content decisions where they belong.
|
||||||
|
}
|
||||||
|
\details{
|
||||||
|
`flextable`, `officer`, and `ragg` are Suggested (not Imported) to keep the
|
||||||
|
base install light, so this function errors with an install hint if
|
||||||
|
`flextable` is unavailable.
|
||||||
|
}
|
||||||
|
\examples{
|
||||||
|
\dontrun{
|
||||||
|
library(flextable)
|
||||||
|
ft <- flextable(head(mtcars)) |>
|
||||||
|
add_header_lines("Motor Trend Cars") |>
|
||||||
|
add_footer_lines("Source: mtcars") |>
|
||||||
|
style_flextable_civilytics()
|
||||||
|
}
|
||||||
|
}
|
||||||
|
\seealso{
|
||||||
|
[save_branded_flextable_png()] to export the styled table to a
|
||||||
|
logo-stamped PNG.
|
||||||
|
}
|
||||||
+10
-8
@@ -17,7 +17,7 @@ theme_civilytics(
|
|||||||
accent = unname(civilytics_colors["ember_600"]),
|
accent = unname(civilytics_colors["ember_600"]),
|
||||||
strip_color = unname(civilytics_colors["paper_2"]),
|
strip_color = unname(civilytics_colors["paper_2"]),
|
||||||
grid = c("y", "x", "both", "none"),
|
grid = c("y", "x", "both", "none"),
|
||||||
paper_bg = TRUE
|
paper_bg = FALSE
|
||||||
)
|
)
|
||||||
}
|
}
|
||||||
\arguments{
|
\arguments{
|
||||||
@@ -56,10 +56,12 @@ to [civilytics_colors]`["paper_2"]` (`#F2EDE4`).}
|
|||||||
\item{grid}{Character. Which major gridlines to draw: `"y"` (default,
|
\item{grid}{Character. Which major gridlines to draw: `"y"` (default,
|
||||||
horizontal only), `"x"` (vertical only), `"both"`, or `"none"`.}
|
horizontal only), `"x"` (vertical only), `"both"`, or `"none"`.}
|
||||||
|
|
||||||
\item{paper_bg}{Logical. If `TRUE` (default), fill the plot and panel
|
\item{paper_bg}{Logical. If `TRUE`, fill the plot and panel backgrounds
|
||||||
backgrounds with the warm `paper` color. Set to `FALSE` for a
|
with the warm `paper` color (Civilytics cream). Default is `FALSE`
|
||||||
transparent background (useful for slides or overlay on colored
|
(transparent) so that figures composite cleanly onto any background.
|
||||||
surfaces).}
|
Set to `TRUE` for the branded cream canvas. Note: a transparent device
|
||||||
|
background (e.g., `dev = "ragg_png"`, `dev.args = list(background =
|
||||||
|
"transparent")`) is also needed for fully-transparent PNG exports.}
|
||||||
}
|
}
|
||||||
\value{
|
\value{
|
||||||
A complete ggplot2 [ggplot2::theme()] object.
|
A complete ggplot2 [ggplot2::theme()] object.
|
||||||
@@ -105,7 +107,7 @@ shrinkage.
|
|||||||
\dontrun{
|
\dontrun{
|
||||||
library(ggplot2)
|
library(ggplot2)
|
||||||
|
|
||||||
# Default editorial theme
|
# Default — transparent background for embedding
|
||||||
ggplot(mpg, aes(displ, hwy)) +
|
ggplot(mpg, aes(displ, hwy)) +
|
||||||
geom_point() +
|
geom_point() +
|
||||||
theme_civilytics()
|
theme_civilytics()
|
||||||
@@ -116,10 +118,10 @@ ggplot(mpg, aes(displ, hwy, colour = class)) +
|
|||||||
scale_color_civilytics() +
|
scale_color_civilytics() +
|
||||||
theme_civilytics(grid = "both")
|
theme_civilytics(grid = "both")
|
||||||
|
|
||||||
# Transparent background for embedding
|
# Branded cream background (opt-in)
|
||||||
ggplot(mpg, aes(displ, hwy)) +
|
ggplot(mpg, aes(displ, hwy)) +
|
||||||
geom_point() +
|
geom_point() +
|
||||||
theme_civilytics(paper_bg = FALSE)
|
theme_civilytics(paper_bg = TRUE)
|
||||||
|
|
||||||
# Larger text for poster or display
|
# Larger text for poster or display
|
||||||
ggplot(mpg, aes(displ, hwy)) +
|
ggplot(mpg, aes(displ, hwy)) +
|
||||||
|
|||||||
@@ -56,10 +56,10 @@ to [civilytics_colors]`["paper_2"]` (`#F2EDE4`).}
|
|||||||
\item{grid}{Character. Which major gridlines to draw: `"y"` (default,
|
\item{grid}{Character. Which major gridlines to draw: `"y"` (default,
|
||||||
horizontal only), `"x"` (vertical only), `"both"`, or `"none"`.}
|
horizontal only), `"x"` (vertical only), `"both"`, or `"none"`.}
|
||||||
|
|
||||||
\item{paper_bg}{Logical. If `TRUE` (default), fill the plot and panel
|
\item{paper_bg}{Logical. If `TRUE`, fill the plot and panel backgrounds
|
||||||
backgrounds with the warm `paper` color. Set to `FALSE` for a
|
with the warm `paper` color (Civilytics cream). Default is `FALSE`
|
||||||
transparent background (useful for slides or overlay on colored
|
(transparent) so that figures composite cleanly onto any background.
|
||||||
surfaces).}
|
Set to `TRUE` for the branded cream canvas.}
|
||||||
}
|
}
|
||||||
\value{
|
\value{
|
||||||
A complete ggplot2 [ggplot2::theme()] object.
|
A complete ggplot2 [ggplot2::theme()] object.
|
||||||
|
|||||||
@@ -52,10 +52,10 @@ design system.}
|
|||||||
\item{strip_color}{Character. Hex code for facet strip background. Defaults
|
\item{strip_color}{Character. Hex code for facet strip background. Defaults
|
||||||
to [civilytics_colors]`["paper_2"]` (`#F2EDE4`).}
|
to [civilytics_colors]`["paper_2"]` (`#F2EDE4`).}
|
||||||
|
|
||||||
\item{paper_bg}{Logical. If `TRUE` (default), fill the plot and panel
|
\item{paper_bg}{Logical. If `TRUE`, fill the plot and panel backgrounds
|
||||||
backgrounds with the warm `paper` color. Set to `FALSE` for a
|
with the warm `paper` color (Civilytics cream). Default is `FALSE`
|
||||||
transparent background (useful for slides or overlay on colored
|
(transparent) so that figures composite cleanly onto any background.
|
||||||
surfaces).}
|
Set to `TRUE` for the branded cream canvas.}
|
||||||
}
|
}
|
||||||
\value{
|
\value{
|
||||||
A complete ggplot2 [ggplot2::theme()] object.
|
A complete ggplot2 [ggplot2::theme()] object.
|
||||||
|
|||||||
@@ -52,10 +52,10 @@ design system.}
|
|||||||
\item{strip_color}{Character. Hex code for facet strip background. Defaults
|
\item{strip_color}{Character. Hex code for facet strip background. Defaults
|
||||||
to [civilytics_colors]`["paper_2"]` (`#F2EDE4`).}
|
to [civilytics_colors]`["paper_2"]` (`#F2EDE4`).}
|
||||||
|
|
||||||
\item{paper_bg}{Logical. If `TRUE` (default), fill the plot and panel
|
\item{paper_bg}{Logical. If `TRUE`, fill the plot and panel backgrounds
|
||||||
backgrounds with the warm `paper` color. Set to `FALSE` for a
|
with the warm `paper` color (Civilytics cream). Default is `FALSE`
|
||||||
transparent background (useful for slides or overlay on colored
|
(transparent) so that figures composite cleanly onto any background.
|
||||||
surfaces).}
|
Set to `TRUE` for the branded cream canvas.}
|
||||||
}
|
}
|
||||||
\value{
|
\value{
|
||||||
A complete ggplot2 [ggplot2::theme()] object.
|
A complete ggplot2 [ggplot2::theme()] object.
|
||||||
|
|||||||
@@ -56,10 +56,10 @@ to [civilytics_colors]`["paper_2"]` (`#F2EDE4`).}
|
|||||||
\item{grid}{Character. Which major gridlines to draw: `"y"` (default,
|
\item{grid}{Character. Which major gridlines to draw: `"y"` (default,
|
||||||
horizontal only), `"x"` (vertical only), `"both"`, or `"none"`.}
|
horizontal only), `"x"` (vertical only), `"both"`, or `"none"`.}
|
||||||
|
|
||||||
\item{paper_bg}{Logical. If `TRUE` (default), fill the plot and panel
|
\item{paper_bg}{Logical. If `TRUE`, fill the plot and panel backgrounds
|
||||||
backgrounds with the warm `paper` color. Set to `FALSE` for a
|
with the warm `paper` color (Civilytics cream). Default is `FALSE`
|
||||||
transparent background (useful for slides or overlay on colored
|
(transparent) so that figures composite cleanly onto any background.
|
||||||
surfaces).}
|
Set to `TRUE` for the branded cream canvas.}
|
||||||
}
|
}
|
||||||
\value{
|
\value{
|
||||||
A complete ggplot2 [ggplot2::theme()] object.
|
A complete ggplot2 [ggplot2::theme()] object.
|
||||||
|
|||||||
@@ -52,10 +52,10 @@ design system.}
|
|||||||
\item{strip_color}{Character. Hex code for facet strip background. Defaults
|
\item{strip_color}{Character. Hex code for facet strip background. Defaults
|
||||||
to [civilytics_colors]`["paper_2"]` (`#F2EDE4`).}
|
to [civilytics_colors]`["paper_2"]` (`#F2EDE4`).}
|
||||||
|
|
||||||
\item{paper_bg}{Logical. If `TRUE` (default), fill the plot and panel
|
\item{paper_bg}{Logical. If `TRUE`, fill the plot and panel backgrounds
|
||||||
backgrounds with the warm `paper` color. Set to `FALSE` for a
|
with the warm `paper` color (Civilytics cream). Default is `FALSE`
|
||||||
transparent background (useful for slides or overlay on colored
|
(transparent) so that figures composite cleanly onto any background.
|
||||||
surfaces).}
|
Set to `TRUE` for the branded cream canvas.}
|
||||||
}
|
}
|
||||||
\value{
|
\value{
|
||||||
A complete ggplot2 [ggplot2::theme()] object.
|
A complete ggplot2 [ggplot2::theme()] object.
|
||||||
|
|||||||
@@ -0,0 +1,89 @@
|
|||||||
|
test_that("style_flextable_civilytics returns a styled flextable", {
|
||||||
|
skip_if_not_installed("flextable")
|
||||||
|
skip_if_not_installed("officer")
|
||||||
|
|
||||||
|
ft <- flextable::flextable(head(mtcars, 4))
|
||||||
|
ft <- flextable::add_footer_lines(ft, "Source: mtcars")
|
||||||
|
styled <- style_flextable_civilytics(ft)
|
||||||
|
|
||||||
|
expect_s3_class(styled, "flextable")
|
||||||
|
# Fixed layout is the documented end-state of the styling.
|
||||||
|
expect_identical(styled$properties$layout, "fixed")
|
||||||
|
})
|
||||||
|
|
||||||
|
test_that("style_flextable_civilytics is idempotent on a 1-row table (no zebra error)", {
|
||||||
|
skip_if_not_installed("flextable")
|
||||||
|
skip_if_not_installed("officer")
|
||||||
|
|
||||||
|
ft <- flextable::flextable(head(mtcars, 1))
|
||||||
|
expect_no_error(once <- style_flextable_civilytics(ft))
|
||||||
|
# Re-styling an already-styled table must not error either.
|
||||||
|
expect_no_error(twice <- style_flextable_civilytics(once))
|
||||||
|
expect_s3_class(twice, "flextable")
|
||||||
|
})
|
||||||
|
|
||||||
|
test_that("zebra = FALSE still returns a valid flextable", {
|
||||||
|
skip_if_not_installed("flextable")
|
||||||
|
skip_if_not_installed("officer")
|
||||||
|
|
||||||
|
ft <- flextable::flextable(head(mtcars, 6))
|
||||||
|
expect_s3_class(style_flextable_civilytics(ft, zebra = FALSE), "flextable")
|
||||||
|
})
|
||||||
|
|
||||||
|
test_that("save_branded_flextable_png writes a PNG with plausible dimensions", {
|
||||||
|
skip_if_not_installed("flextable")
|
||||||
|
skip_if_not_installed("officer")
|
||||||
|
skip_if_not_installed("ragg")
|
||||||
|
skip_if_not_installed("png")
|
||||||
|
|
||||||
|
ft <- flextable::flextable(head(mtcars, 4))
|
||||||
|
ft <- flextable::add_footer_lines(ft, "Source: mtcars")
|
||||||
|
ft <- style_flextable_civilytics(ft)
|
||||||
|
|
||||||
|
path <- tempfile(fileext = ".png")
|
||||||
|
on.exit(unlink(path), add = TRUE)
|
||||||
|
|
||||||
|
out <- save_branded_flextable_png(ft, path)
|
||||||
|
|
||||||
|
expect_identical(out, path)
|
||||||
|
expect_true(file.exists(path))
|
||||||
|
|
||||||
|
dims <- dim(png::readPNG(path))
|
||||||
|
# height x width x channels — a real table is at least a few hundred px each.
|
||||||
|
expect_gt(dims[1], 50)
|
||||||
|
expect_gt(dims[2], 50)
|
||||||
|
})
|
||||||
|
|
||||||
|
test_that("save_branded_flextable_png with logo = FALSE skips stamping but still writes", {
|
||||||
|
skip_if_not_installed("flextable")
|
||||||
|
skip_if_not_installed("officer")
|
||||||
|
skip_if_not_installed("ragg")
|
||||||
|
skip_if_not_installed("png")
|
||||||
|
|
||||||
|
ft <- style_flextable_civilytics(flextable::flextable(head(mtcars, 3)))
|
||||||
|
|
||||||
|
path <- tempfile(fileext = ".png")
|
||||||
|
on.exit(unlink(path), add = TRUE)
|
||||||
|
|
||||||
|
save_branded_flextable_png(ft, path, logo = FALSE)
|
||||||
|
expect_true(file.exists(path))
|
||||||
|
expect_gt(file.info(path)$size, 0)
|
||||||
|
})
|
||||||
|
|
||||||
|
test_that("extra_height increases the exported PNG height", {
|
||||||
|
skip_if_not_installed("flextable")
|
||||||
|
skip_if_not_installed("officer")
|
||||||
|
skip_if_not_installed("ragg")
|
||||||
|
skip_if_not_installed("png")
|
||||||
|
|
||||||
|
ft <- style_flextable_civilytics(flextable::flextable(head(mtcars, 4)))
|
||||||
|
|
||||||
|
path_small <- tempfile(fileext = ".png")
|
||||||
|
path_big <- tempfile(fileext = ".png")
|
||||||
|
on.exit(unlink(c(path_small, path_big)), add = TRUE)
|
||||||
|
|
||||||
|
save_branded_flextable_png(ft, path_small, logo = FALSE, extra_height = 0)
|
||||||
|
save_branded_flextable_png(ft, path_big, logo = FALSE, extra_height = 2)
|
||||||
|
|
||||||
|
expect_gt(dim(png::readPNG(path_big))[1], dim(png::readPNG(path_small))[1])
|
||||||
|
})
|
||||||
@@ -0,0 +1,30 @@
|
|||||||
|
test_that("stamp_logo_png preserves image dimensions and returns the path invisibly", {
|
||||||
|
p <- tempfile(fileext = ".png")
|
||||||
|
on.exit(unlink(p), add = TRUE)
|
||||||
|
grDevices::png(p, width = 600, height = 240); plot(1:5); grDevices::dev.off()
|
||||||
|
in_dim <- dim(png::readPNG(p))[1:2]
|
||||||
|
|
||||||
|
expect_invisible(out <- stamp_logo_png(p))
|
||||||
|
expect_identical(out, p)
|
||||||
|
expect_identical(dim(png::readPNG(p))[1:2], in_dim) # overwritten at same size
|
||||||
|
})
|
||||||
|
|
||||||
|
test_that("stamp_logo_png runs for every type/variant/position combination", {
|
||||||
|
p <- tempfile(fileext = ".png")
|
||||||
|
on.exit(unlink(p), add = TRUE)
|
||||||
|
grDevices::png(p, width = 500, height = 200); plot(1:5); grDevices::dev.off()
|
||||||
|
|
||||||
|
for (ty in c("wordmark", "mark")) {
|
||||||
|
for (va in c("light", "dark")) {
|
||||||
|
for (pos in c("bottom-right", "bottom-left", "top-right", "top-left")) {
|
||||||
|
expect_no_error(stamp_logo_png(p, type = ty, variant = va, position = pos))
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
})
|
||||||
|
|
||||||
|
test_that("stamp_logo_png validates its inputs", {
|
||||||
|
expect_error(stamp_logo_png(tempfile(fileext = ".png"))) # file does not exist
|
||||||
|
# invalid type is rejected by match.arg() before the file is touched
|
||||||
|
expect_error(stamp_logo_png(tempfile(fileext = ".png"), type = "banner"))
|
||||||
|
})
|
||||||
@@ -133,8 +133,13 @@ test_that("theme_civilytics uses brand ink color for text", {
|
|||||||
expect_equal(th$text$colour, unname(civilytics_colors["ink"]))
|
expect_equal(th$text$colour, unname(civilytics_colors["ink"]))
|
||||||
})
|
})
|
||||||
|
|
||||||
test_that("theme_civilytics uses brand paper color for plot background", {
|
test_that("theme_civilytics has transparent background by default", {
|
||||||
th <- theme_civilytics()
|
th <- theme_civilytics()
|
||||||
|
expect_true(is.na(th$plot.background$fill))
|
||||||
|
})
|
||||||
|
|
||||||
|
test_that("theme_civilytics uses brand paper color when paper_bg = TRUE", {
|
||||||
|
th <- theme_civilytics(paper_bg = TRUE)
|
||||||
expect_equal(th$plot.background$fill, unname(civilytics_colors["paper"]))
|
expect_equal(th$plot.background$fill, unname(civilytics_colors["paper"]))
|
||||||
})
|
})
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user