Compare commits
6
Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
4fb5c488f8
|
||
|
|
96dc1c4c6b | ||
|
|
6ea9265236 | ||
|
|
b9d427eb76
|
||
|
|
a904d2313a
|
||
|
|
4f51a49903
|
+5
-2
@@ -1,7 +1,7 @@
|
||||
Package: civilytics
|
||||
Type: Package
|
||||
Title: Brand Themes, Color Palettes, and Utility Functions for Civilytics
|
||||
Version: 0.2.0
|
||||
Version: 0.3.1
|
||||
Authors@R:
|
||||
person("Jared", "E. Knowles", email = "jared@civilytics.com",
|
||||
role = c("aut", "cre"))
|
||||
@@ -31,7 +31,10 @@ Encoding: UTF-8
|
||||
Suggests:
|
||||
testthat (>= 3.0.0),
|
||||
tidycensus,
|
||||
quarto
|
||||
quarto,
|
||||
flextable,
|
||||
officer,
|
||||
ragg
|
||||
Config/testthat/edition: 3
|
||||
Config/roxygen2/version: 8.0.0
|
||||
RoxygenNote: 7.3.3
|
||||
|
||||
@@ -39,11 +39,13 @@ export(rnh)
|
||||
export(round_to_nearest_half)
|
||||
export(safe_max)
|
||||
export(safe_ratio)
|
||||
export(save_branded_flextable_png)
|
||||
export(scale_color_civilytics)
|
||||
export(scale_fill_civilytics)
|
||||
export(simpleCap)
|
||||
export(stamp_logo_png)
|
||||
export(star_subs)
|
||||
export(style_flextable_civilytics)
|
||||
export(theme_civilytics)
|
||||
export(theme_civilytics_dark)
|
||||
export(theme_civilytics_dark_map)
|
||||
|
||||
@@ -111,9 +111,7 @@ nvals <- function(x){
|
||||
#' simpleCap(my_string)
|
||||
simpleCap <- function(x) {
|
||||
stopifnot(class(x) == "character")
|
||||
sapply(x, function(word) {
|
||||
s <- strsplit(word, " ")[[1]]
|
||||
paste(toupper(substring(s, 1, 1)), substring(s, 2),
|
||||
s <- strsplit(x, " ")[[1]]
|
||||
paste(toupper(substring(s, 1,1)), substring(s, 2),
|
||||
sep = "", collapse = " ")
|
||||
})
|
||||
}
|
||||
|
||||
+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)
|
||||
}
|
||||
+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)
|
||||
}
|
||||
|
||||
# Typst
|
||||
.copy_pkg_file(
|
||||
"quarto/typst/civilytics-typst.typ",
|
||||
"typst/civilytics-typst.typ",
|
||||
path, force
|
||||
)
|
||||
# Typst — shipped as template-partials so Quarto keeps its Skylighting
|
||||
# definitions and syntax-highlighted code blocks render (see issue #12)
|
||||
typst_files <- c("typst-template.typ", "typst-show.typ")
|
||||
for (f in typst_files) {
|
||||
.copy_pkg_file(file.path("quarto/typst", f), file.path("typst", f), path, force)
|
||||
}
|
||||
|
||||
# Logos — for _brand.yml (expects assets/logo/)
|
||||
.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-before-body: latex/civilytics-title.tex")
|
||||
message(" typst:")
|
||||
message(" template: typst/civilytics-typst.typ")
|
||||
message(" template-partials:")
|
||||
message(" - typst/typst-template.typ")
|
||||
message(" - typst/typst-show.typ")
|
||||
message("---")
|
||||
message("\nSee examples/report.qmd for a complete example.")
|
||||
invisible(NULL)
|
||||
|
||||
@@ -36,9 +36,10 @@
|
||||
#' to [civilytics_colors]`["paper_2"]` (`#F2EDE4`).
|
||||
#' @param grid Character. Which major gridlines to draw: `"y"` (default,
|
||||
#' horizontal only), `"x"` (vertical only), `"both"`, or `"none"`.
|
||||
#' @param paper_bg Logical. If `FALSE` (default), the plot and panel
|
||||
#' backgrounds are transparent (`fill = NA`). Set to `TRUE` to fill them
|
||||
#' with the warm `paper` color (the Civilytics cream canvas).
|
||||
#' @param paper_bg Logical. If `TRUE` (default), fill the plot and panel
|
||||
#' backgrounds with the warm `paper` color. Set to `FALSE` for a
|
||||
#' transparent background (useful for slides or overlay on colored
|
||||
#' surfaces).
|
||||
#'
|
||||
#' @section Font size hierarchy:
|
||||
#' All text sizes are derived from `font_size` using relative scale factors.
|
||||
@@ -67,29 +68,26 @@
|
||||
#' \dontrun{
|
||||
#' library(ggplot2)
|
||||
#'
|
||||
#' # Transparent background (default) — composites cleanly onto any surface
|
||||
#' # Default editorial theme
|
||||
#' ggplot(mpg, aes(displ, hwy)) +
|
||||
#' geom_point() +
|
||||
#' theme_civilytics()
|
||||
#'
|
||||
#' # Warm paper canvas (opt-in)
|
||||
#' ggplot(mpg, aes(displ, hwy)) +
|
||||
#' geom_point() +
|
||||
#' theme_civilytics(paper_bg = TRUE)
|
||||
#'
|
||||
#' # With both gridlines and brand colors
|
||||
#' ggplot(mpg, aes(displ, hwy, colour = class)) +
|
||||
#' geom_point() +
|
||||
#' scale_color_civilytics() +
|
||||
#' theme_civilytics(grid = "both")
|
||||
#'
|
||||
#' # Transparent background for embedding
|
||||
#' ggplot(mpg, aes(displ, hwy)) +
|
||||
#' geom_point() +
|
||||
#' theme_civilytics(paper_bg = FALSE)
|
||||
#'
|
||||
#' # Larger text for poster or display
|
||||
#' ggplot(mpg, aes(displ, hwy)) +
|
||||
#' geom_point() +
|
||||
#' theme_civilytics(font_size = 18)
|
||||
#'
|
||||
#' # Note: for fully-transparent PNGs, also set a transparent device
|
||||
#' # background (e.g. `ggsave("plot.png", bg = NA)`).
|
||||
#' }
|
||||
theme_civilytics <- function(
|
||||
font_size = 14,
|
||||
@@ -104,7 +102,7 @@ theme_civilytics <- function(
|
||||
accent = unname(civilytics_colors["ember_600"]),
|
||||
strip_color = unname(civilytics_colors["paper_2"]),
|
||||
grid = c("y", "x", "both", "none"),
|
||||
paper_bg = FALSE) {
|
||||
paper_bg = TRUE) {
|
||||
|
||||
grid <- match.arg(grid)
|
||||
half_line <- font_size / 2
|
||||
|
||||
@@ -31,7 +31,7 @@ safe_max <- function(x) {
|
||||
#' pretty_per(0.2, ndigit = 1)
|
||||
#' pretty_per(c(0.2, 0.332423, 0.4, 0.342342), ndigit = 2)
|
||||
pretty_per <- function(x, ndigit = 1) {
|
||||
if (any(x >= 100) && !all(is.na(x))) {
|
||||
if (any(x >= 100) & !all(is.na(x))) {
|
||||
message("Values over 100 found, did you mean to use proportions?")
|
||||
}
|
||||
x <- format(round(x, digits = ndigit + 2) * 100, nsmall = ndigit)
|
||||
@@ -283,7 +283,7 @@ get_stabbr <- function(fips) {
|
||||
fips_codes <- fips_codes[!duplicated(fips_codes),]
|
||||
if (length(fips) != 1) {
|
||||
out <- rep(NA, length(fips))
|
||||
for (i in seq_along(fips)) {
|
||||
for (i in length(fips)) {
|
||||
out[i] <- fips_codes[fips_codes$state_code == fips, 1]
|
||||
|
||||
}
|
||||
@@ -375,7 +375,7 @@ random_round <- function(x) {
|
||||
add = rep(as.integer(0),length(r))
|
||||
add[r>test] <- as.integer(1)
|
||||
value = v + add
|
||||
value <- ifelse(is.na(value) | value < 0, 0, value)
|
||||
ifelse(is.na(value) | value<0, 0, value)
|
||||
return(value)
|
||||
}
|
||||
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
title: "Who pays when rent outpaces wages?"
|
||||
subtitle: "A 12-county analysis of cost-burdened renter households, 2019–2024."
|
||||
author:
|
||||
- name: "Civilytics Research"
|
||||
- name: "Jared Knowles"
|
||||
affiliation: "Civilytics Consulting"
|
||||
date: "2026-04-15"
|
||||
abstract: |
|
||||
@@ -19,7 +19,9 @@ format:
|
||||
toc: true
|
||||
toc-location: right
|
||||
typst:
|
||||
template: ../typst/civilytics-typst.typ
|
||||
template-partials:
|
||||
- ../typst/typst-template.typ
|
||||
- ../typst/typst-show.typ
|
||||
pdf:
|
||||
include-in-header: ../latex/civilytics.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.
|
||||
|
||||
Civilytics Research, 2026
|
||||
Civilytics Consulting, 2026
|
||||
|
||||
## Thank you {.thank-you}
|
||||
|
||||
Questions?
|
||||
|
||||
- jared@civilytics.com
|
||||
- civilytics.consulting
|
||||
- civilytics.com
|
||||
|
||||
@@ -2,11 +2,16 @@
|
||||
% Replaces Quarto's default \maketitle. Uses values from YAML
|
||||
% (\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}
|
||||
\pagecolor{paper}
|
||||
\color{ink}
|
||||
\vspace*{0.5in}
|
||||
{\sffamily\bfseries\scriptsize\color{ember}\MakeUppercase{— Civilytics Research}\par}
|
||||
{\sffamily\bfseries\scriptsize\color{ember}\MakeUppercase{— Civilytics Consulting}\par}
|
||||
\vspace{12pt}
|
||||
{\displayfont\fontsize{32pt}{34pt}\selectfont\bfseries\color{ink}\thetitle\par}
|
||||
\vspace{8pt}
|
||||
@@ -33,8 +38,6 @@
|
||||
|
||||
% Pulse mark, in ember
|
||||
\begin{center}
|
||||
\begin{tikzpicture}[overlay, remember picture]
|
||||
\end{tikzpicture}
|
||||
{\color{ember}\rule{40pt}{2pt}}
|
||||
\end{center}
|
||||
\end{titlepage}
|
||||
|
||||
@@ -40,17 +40,40 @@
|
||||
\color{ink}
|
||||
|
||||
% --- 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}[
|
||||
UprightFont = *,
|
||||
ItalicFont = * Italic,
|
||||
BoldFont = * SemiBold,
|
||||
BoldItalicFont = * SemiBold Italic,
|
||||
Ligatures = TeX,
|
||||
]
|
||||
\setsansfont{Inter}[Ligatures = TeX]
|
||||
\setmonofont{JetBrains Mono}[Scale = 0.92]
|
||||
\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 ---
|
||||
\hypersetup{
|
||||
colorlinks = true,
|
||||
@@ -77,7 +100,7 @@
|
||||
\renewcommand{\footrulewidth}{0pt}
|
||||
\fancyhead[L]{\sffamily\scriptsize\color{ink3}\MakeUppercase{Civilytics Consulting}}
|
||||
\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[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:
|
||||
// format:
|
||||
// typst:
|
||||
// template: quarto/typst/civilytics-typst.typ
|
||||
// template-partials:
|
||||
// - quarto/typst/typst-template.typ
|
||||
// - quarto/typst/typst-show.typ
|
||||
// =============================================================
|
||||
|
||||
#let paper-bg = rgb("#FAF7F2")
|
||||
@@ -54,7 +60,7 @@
|
||||
grid(
|
||||
columns: (1fr, auto, 1fr),
|
||||
align: (left, center, right),
|
||||
[civilytics.consulting],
|
||||
[civilytics.com],
|
||||
counter(page).display("1 / 1", both: true),
|
||||
[© 2026]
|
||||
)
|
||||
@@ -158,7 +164,7 @@
|
||||
if title != none {
|
||||
block[
|
||||
#set text(font: sans-stack, size: 8pt, weight: 600, fill: ember, tracking: 0.1em)
|
||||
#upper[— Civilytics Research]
|
||||
#upper[— Civilytics Consulting]
|
||||
]
|
||||
v(8pt)
|
||||
block[
|
||||
@@ -229,16 +235,3 @@
|
||||
|
||||
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$
|
||||
@@ -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,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.
|
||||
}
|
||||
@@ -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])
|
||||
})
|
||||
@@ -133,17 +133,9 @@ test_that("theme_civilytics uses brand ink color for text", {
|
||||
expect_equal(th$text$colour, unname(civilytics_colors["ink"]))
|
||||
})
|
||||
|
||||
test_that("theme_civilytics has transparent background by default", {
|
||||
test_that("theme_civilytics uses brand paper color for plot background", {
|
||||
th <- theme_civilytics()
|
||||
expect_true(is.na(th$plot.background$fill))
|
||||
expect_true(is.na(th$panel.background$fill))
|
||||
expect_null(th$legend.background$fill)
|
||||
})
|
||||
|
||||
test_that("theme_civilytics paper_bg=TRUE opt-in fills with cream", {
|
||||
th <- theme_civilytics(paper_bg = TRUE)
|
||||
expect_equal(th$plot.background$fill, unname(civilytics_colors["paper"]))
|
||||
expect_equal(th$panel.background$fill, unname(civilytics_colors["paper"]))
|
||||
})
|
||||
|
||||
test_that("theme_civilytics uses paper_2 for strip background by default", {
|
||||
|
||||
Reference in New Issue
Block a user