Skip to contents

Create a custom Quarto project

Source: R/quarto_project.R
quarto_project.Rd

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, base_dir = getwd(), custom_yaml = TRUE)

Arguments

name

Character string. The name of the Quarto project directory and initial .qmd file.

base_dir

Character string. Base directory where the project should be created. Defaults to the current working directory.

custom_yaml

Logical. If TRUE (default), uses a custom YAML header in the initial .qmd file, populated with values from '_variables.yml'. If FALSE, uses Quarto's standard YAML header.

Value

Invisibly returns the path to the created project directory.

Details

This function creates a Quarto project with the following enhancements:

  • _variables.yml: Stores reusable YAML variables (if custom_yaml = TRUE)

  • .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 custom_yaml = TRUE)

  • .Rproj: RStudio project file

If froggeR settings don't exist, it will prompt to create them.

See also

write_quarto, froggeR_settings

Examples

if (FALSE) { # \dontrun{
  # Create a new Quarto project with custom formatted YAML header
  quarto_project('frogs', base_dir = tempdir(), custom_yaml = TRUE)

  # Create a new Quarto project with standard Quarto YAML
  quarto_project('frogs_standard', base_dir = tempdir(), custom_yaml = FALSE)
} # }