quarto_project {froggeR} | R Documentation |
Create a Custom 'Quarto' Project
Description
This function creates a new 'Quarto' project directory with additional froggeR
features. It first calls quarto::quarto_create_project()
to set up the
basic structure, then enhances it with froggeR-specific files and settings.
Usage
quarto_project(name, path = here::here(), example = TRUE)
Arguments
name |
Character string. The name of the 'Quarto' project directory and
initial |
path |
Character string. Path to the project directory. |
example |
Logical. If TRUE (default), creates a Quarto document with a default to position the brand logo and examples of within-document cross-referencing, links, and references. |
Details
This function creates a 'Quarto' project with the following enhancements:
-
_brand.yml
: Stores Quarto project branding -
logos
: Quarto project branding logos directory -
_variables.yml
: Stores reusable YAML variables -
.gitignore
: Enhanced settings for R projects -
README.md
: Template README file -
dated_progress_notes.md
: For project progress tracking -
custom.scss
: Custom 'Quarto' styling
If froggeR settings don't exist, it will prompt to create them.
Value
Invisibly returns the path to the created project directory.
See Also
Examples
if (interactive() && quarto::quarto_version() >= "1.6") {
# Create the Quarto project with custom YAML & associated files
quarto_project("frogs", path = tempdir(), example = TRUE)
# Confirms files were created (optional, for user confirmation)
file.exists(file.path(tempdir(), "frogs.qmd")) # Quarto doc
file.exists(file.path(tempdir(), "_quarto.yml")) # project YAML file
# Create a new Quarto project with standard Quarto (no examples)
# quarto_project('frogs_standard', path = tempdir(), example = FALSE)
}