write_variables: Write Variables YAML for Quarto Projects

View source: R/write_variables.R

write_variablesR Documentation

Write Variables YAML for Quarto Projects

Description

Creates or opens a _variables.yml file in a Quarto project for editing. If the file already exists, it is opened directly. If global froggeR settings exist, those are used as the starting point. Otherwise, the template is downloaded from the frogger-templates repository.

Usage

write_variables(path = here::here())

Arguments

path

Character. Path to the project directory. Default is current project root via here.

Details

The _variables.yml file stores reusable author metadata that Quarto documents can reference. Available fields:

  • name: Your full name as it appears in publications

  • email: Contact email address

  • orcid: ORCID identifier (e.g., 0000-0001-2345-6789)

  • url: Personal website or profile URL

  • github: GitHub username

  • affiliations: Institution, department, etc.

Use save_variables to persist your project-level metadata to the global config directory for reuse across projects.

Value

Invisibly returns the path to the file.

See Also

save_variables, write_brand, init

Examples

## Not run: 
write_variables()

## End(Not run)


froggeR documentation built on March 17, 2026, 9:06 a.m.