Skip to content

Replace global variable defaults with getOption() pattern #129

@NewGraphEnvironment

Description

@NewGraphEnvironment

Problem

Many fpr functions use global variables as default arguments:

fpr_kable <- function(dat, font = font_set, ...) {

This works in RStudio (persistent global env) but fails in scripted/CI contexts like GitHub Actions builds where environment scoping is stricter.

Error example:

Error in `fpr::fpr_kable()`:
! object 'font_set' not found

Proposed Solution

Replace global variable defaults with getOption() pattern:

fpr_kable <- function(dat, font = getOption("fpr.font_set", 11), ...) {

Implementation

  1. Audit functions for global variable dependencies
  2. Create options list with defaults:
# In zzz.R or similar
.onLoad <- function(libname, pkgname) {
  options(
    fpr.font_set = 11,
    fpr.photo_width = "100%"
    # ... other defaults
  )
}
  1. Update function signatures to use getOption()
  2. Document available options in package docs

Benefits

  • Works in interactive AND scripted contexts
  • Users can override via options(fpr.font_set = 14)
  • Enables GitHub Actions builds for bookdown reports
  • Cleaner, more explicit design

Known Global Variables to Audit

  • font_set
  • photo_width
  • (need full audit)

Related

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions