fix: address review round 5 for #7

DESCRIPTION

@@ -29,9 +29,9 @@ Imports:
     sysfonts
 Encoding: UTF-8
 Suggests:
+    quarto,
     testthat (>= 3.0.0),
-    tidycensus,
+    tidycensus
-    quarto
 Config/testthat/edition: 3
 Config/roxygen2/version: 8.0.0
 RoxygenNote: 7.3.3

NAMESPACE

@@ -42,7 +42,6 @@ export(safe_ratio)
 export(scale_color_civilytics)
 export(scale_fill_civilytics)
 export(simpleCap)
-export(stamp_logo_png)
 export(star_subs)
 export(theme_civilytics)
 export(theme_civilytics_dark)
@@ -62,12 +61,8 @@ importFrom(ggplot2,annotation_custom)
 importFrom(ggplot2,ggplot)
 importFrom(ggplot2,theme)
 importFrom(ggplot2,theme_void)
-importFrom(grDevices,dev.off)
-importFrom(grDevices,png)
 importFrom(graphics,rasterImage)
 importFrom(grid,grid.draw)
-importFrom(grid,grid.newpage)
-importFrom(grid,grid.raster)
 importFrom(grid,rasterGrob)
 importFrom(gridExtra,arrangeGrob)
 importFrom(jpeg,readJPEG)

R/db.R

@@ -111,9 +111,7 @@ nvals <- function(x){
 #' simpleCap(my_string)
 simpleCap <- function(x) {
   stopifnot(class(x) == "character")
-  sapply(x, function(word) {
+  s <- strsplit(x, " ")[[1]]
-    s <- strsplit(word, " ")[[1]]
+  paste(toupper(substring(s, 1,1)), substring(s, 2),
-    paste(toupper(substring(s, 1, 1)), substring(s, 2),
+        sep = "", collapse = " ")
-          sep = "", collapse = " ")
-  })
 }

R/logo.R

@@ -361,92 +361,3 @@ civilytics_logo <- function(plot,
            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)
-}

R/theme.R

@@ -29,16 +29,26 @@
 #' @param ink Character. Hex code for foreground/text color. Defaults to
 #'   [civilytics_colors]`["ink"]` (`#0E1A2B`).
 #' @param paper Character. Hex code for background color. Defaults to
-#'   [civilytics_colors]`["paper"]` (`#FAF7F2`).
+#'   [civilytics_colors]`["paper"]` (`#FAF7F2`). Only used when
+#'   `paper_bg = TRUE`.
 #' @param accent Character. Hex code for accent/highlight color. Defaults to
 #'   [civilytics_colors]`["ember_600"]` (`#C25311`).
 #' @param strip_color Character. Hex code for facet strip background. Defaults
 #'   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
+#' @param paper_bg Logical. If `TRUE`, fill the plot and panel
-#'   backgrounds are transparent (`fill = NA`). Set to `TRUE` to fill them
+#'   backgrounds with the warm `paper` color. Default `FALSE` for a
-#'   with the warm `paper` color (the Civilytics cream canvas).
+#'   transparent background (recommended for embedding figures on
+#'   colored surfaces, slides, or report pages). Set to `TRUE` to
+#'   enable the branded cream canvas.
+#'
+#' @section Device background note:
+#' When saving plots to PNG with `ggsave()`, the transparent default
+#' means the plot area will not have a solid background fill. If you
+#' need a solid background in your exported PNG, set `paper_bg = TRUE`
+#' or add `+ theme(plot.background = element_rect(fill = "white"))`
+#' before saving.
 #'
 #' @section Font size hierarchy:
 #' All text sizes are derived from `font_size` using relative scale factors.
@@ -67,29 +77,26 @@
 #' \dontrun{
 #' library(ggplot2)
 #'
-#' # Transparent background (default) — composites cleanly onto any surface
+#' # Default transparent background
 #' 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")
 #'
+#' # Branded cream canvas (opt-in)
+#' ggplot(mpg, aes(displ, hwy)) +
+#'   geom_point() +
+#'   theme_civilytics(paper_bg = TRUE)
+#'
 #' # 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,

R/utils.R

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

man/stamp_logo_png.Rd

@@ -1,56 +0,0 @@
-% 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")
-}
-}

tests/testthat/test_logo.R

@@ -1,30 +0,0 @@
-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"))
-})

tests/testthat/test_theme.R

@@ -133,14 +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 has transparent background by default", {
+test_that("theme_civilytics defaults to transparent 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", {
+test_that("theme_civilytics paper_bg=TRUE restores cream background", {
   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"]))