init: Initialize a froggeR Project from the Template

In froggeR: Project Scaffolding for R and 'Quarto'

Initialize a froggeR Project from the Template

Description

Downloads the latest project scaffold from the frogger-templates repository and restores any saved user configuration. This is the recommended way to start a new froggeR project.

Usage

init(path = here::here())

Arguments

path	Character. Directory where the project will be created. If the directory does not exist, it will be created. Default is current project root via here.

Details

The function performs these steps:

1. Creates the target directory if it does not exist

2. Downloads the latest template zip from GitHub

3. Copies only files that do not already exist (never overwrites)

4. Restores saved user config (_variables.yml, _brand.yml, logos/) from ~/.config/froggeR/ if present

5. Creates a data/ directory (gitignored by default)

Existing files are never overwritten. Each created and skipped file is reported individually so you can see exactly what changed.

Global configuration is saved via save_variables and save_brand. If no saved config exists, the template defaults are used as-is.

Value

Invisibly returns the normalized path.

See Also

write_variables, write_brand, save_variables, save_brand

Examples

## Not run: 
# Create a new project (directory is created automatically)
init(path = file.path(tempdir(), "my-project"))

## End(Not run)

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