docs: regenerate roxygen documentation for paper_bg and force params (#19)

- Replace .cv_fonts_loaded <<- TRUE with environment-based state
  (.cv_state) to avoid 'locked namespace binding' error (#18)
- Add force=FALSE argument for idempotent font loading with guard check
- Flip theme_civilytics() paper_bg default to FALSE (transparent) (#7)
- Update roxygen docs and examples for both changes

DESCRIPTION

@@ -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"))

R/fonts.R

@@ -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_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
 #'
-#' 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
 #'
 #' @examples
 #' \dontrun{
 #' 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("Libre Franklin", family = "Libre Franklin")
   sysfonts::font_add_google("Source Serif 4", family = "Source Serif 4")
   sysfonts::font_add_google("JetBrains Mono", family = "JetBrains Mono")
   showtext::showtext_auto()
-  .cv_fonts_loaded <<- TRUE
+
-  invisible(NULL)
+  .cv_state$fonts_loaded <- TRUE
+  invisible(TRUE)
 }
 
 .onLoad <- function(libname, pkgname) {

R/quarto.R

@@ -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
+  # 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/)
   .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)

R/theme.R

@@ -36,10 +36,12 @@
 #'   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 `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:
 #' All text sizes are derived from `font_size` using relative scale factors.
@@ -68,7 +70,7 @@
 #' \dontrun{
 #' library(ggplot2)
 #'
-#' # Default editorial theme
+#' # Default — transparent background for embedding
 #' ggplot(mpg, aes(displ, hwy)) +
 #'   geom_point() +
 #'   theme_civilytics()
@@ -79,10 +81,10 @@
 #'   scale_color_civilytics() +
 #'   theme_civilytics(grid = "both")
 #'
-#' # Transparent background for embedding
+#' # Branded cream background (opt-in)
 #' ggplot(mpg, aes(displ, hwy)) +
 #'   geom_point() +
-#'   theme_civilytics(paper_bg = FALSE)
+#'   theme_civilytics(paper_bg = TRUE)
 #'
 #' # Larger text for poster or display
 #' ggplot(mpg, aes(displ, hwy)) +
@@ -102,7 +104,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     = TRUE) {
+    paper_bg     = FALSE) {
 
   grid <- match.arg(grid)
   half_line  <- font_size / 2

inst/quarto/examples/report.qmd

@@ -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

inst/quarto/examples/slides.qmd

@@ -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

inst/quarto/latex/civilytics-title.tex

@@ -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}

inst/quarto/latex/civilytics.tex

@@ -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}
 

inst/quarto/typst/typst-show.typ

@@ -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
+)

inst/quarto/typst/typst-template.typ

@@ -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$

man/civilytics_load_fonts.Rd

@@ -4,17 +4,25 @@
 \alias{civilytics_load_fonts}
 \title{Load Civilytics brand fonts}
 \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{
-Invisibly returns `NULL`.
+Invisibly returns \code{TRUE} if fonts were loaded, \code{FALSE} if skipped
+(already loaded and \code{force = FALSE}).
 }
 \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{
 \dontrun{

man/theme_civilytics.Rd

@@ -17,7 +17,7 @@ theme_civilytics(
   accent = unname(civilytics_colors["ember_600"]),
   strip_color = unname(civilytics_colors["paper_2"]),
   grid = c("y", "x", "both", "none"),
-  paper_bg = TRUE
+  paper_bg = FALSE
 )
 }
 \arguments{
@@ -56,10 +56,12 @@ to [civilytics_colors]`["paper_2"]` (`#F2EDE4`).}
 \item{grid}{Character. Which major gridlines to draw: `"y"` (default,
 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{
 A complete ggplot2 [ggplot2::theme()] object.
@@ -105,7 +107,7 @@ shrinkage.
 \dontrun{
 library(ggplot2)
 
-# Default editorial theme
+# Default — transparent background for embedding
 ggplot(mpg, aes(displ, hwy)) +
   geom_point() +
   theme_civilytics()
@@ -116,10 +118,10 @@ ggplot(mpg, aes(displ, hwy, colour = class)) +
   scale_color_civilytics() +
   theme_civilytics(grid = "both")
 
-# Transparent background for embedding
+# Branded cream background (opt-in)
 ggplot(mpg, aes(displ, hwy)) +
   geom_point() +
-  theme_civilytics(paper_bg = FALSE)
+  theme_civilytics(paper_bg = TRUE)
 
 # Larger text for poster or display
 ggplot(mpg, aes(displ, hwy)) +

man/theme_civilytics_dark.Rd

@@ -56,10 +56,10 @@ to [civilytics_colors]`["paper_2"]` (`#F2EDE4`).}
 \item{grid}{Character. Which major gridlines to draw: `"y"` (default,
 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{
 A complete ggplot2 [ggplot2::theme()] object.

man/theme_civilytics_dark_map.Rd

@@ -52,10 +52,10 @@ design system.}
 \item{strip_color}{Character. Hex code for facet strip background. Defaults
 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{
 A complete ggplot2 [ggplot2::theme()] object.

man/theme_civilytics_map.Rd

@@ -52,10 +52,10 @@ design system.}
 \item{strip_color}{Character. Hex code for facet strip background. Defaults
 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{
 A complete ggplot2 [ggplot2::theme()] object.

man/theme_civilytics_slide.Rd

@@ -56,10 +56,10 @@ to [civilytics_colors]`["paper_2"]` (`#F2EDE4`).}
 \item{grid}{Character. Which major gridlines to draw: `"y"` (default,
 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{
 A complete ggplot2 [ggplot2::theme()] object.

man/theme_civilytics_slide_map.Rd

@@ -52,10 +52,10 @@ design system.}
 \item{strip_color}{Character. Hex code for facet strip background. Defaults
 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{
 A complete ggplot2 [ggplot2::theme()] object.

tests/testthat/test_theme.R

@@ -133,8 +133,13 @@ test_that("theme_civilytics uses brand ink color for text", {
   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()
+  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"]))
 })