Skip to contents

Manage froggeR settings

Source: R/settings.R
froggeR_settings.Rd

This function allows you to check, display, or initialize froggeR settings for Quarto documents. Settings are stored in ~/.config/froggeR/config.yml for persistence across froggeR projects.

Usage

froggeR_settings(update = TRUE)

Arguments

update

Logical. If TRUE (default), prompts to update existing settings or create new ones if none exist.

Value

Invisibly returns the current settings list.

Details

The function manages the following settings:

  • name: Your Name (required)

  • email: your.email@example.com (required)

  • orcid: 0000-0000-0000-0000 (optional)

  • url: https://github.com/yourUsername (optional)

  • affiliations: Your Institution (optional)

  • toc: Table of Contents (defaults to this if left empty)

When run interactively with update = TRUE, it provides a menu-driven interface for updating these settings. If settings don't exist, it will prompt to create them regardless of the update parameter.

Examples

if (FALSE) { # \dontrun{
  # Update settings (interactive)
  froggeR_settings(update = TRUE)

  # Load current settings without updating
  settings <- froggeR_settings(update = FALSE)
  print(settings)
} # }