pages/ directory has been renamed to analysis/, following the
research compendium convention described in Marwick, Boettiger, and Mullen
(2018). write_quarto() now writes to analysis/ instead of pages/.
Thanks to Raymond Balise (@RaymondBalise) for the suggestion and citation.init() no longer swallows directory creation errors. If fs::dir_create()
fails, the actual error is reported instead of a generic "Invalid path."
File writers (write_variables(), write_brand(), write_quarto(), etc.)
check whether file.copy() succeeded before reporting success. A failed copy
raises an error instead of silent success.
save_variables() and save_brand() check whether file.copy() succeeded
before reporting "Saved." A failed copy raises an error instead of silent
success.
init() warns and skips individual template files that fail to copy instead
of silently counting them as created.
quarto_project() has been removed. It now errors with a message directing
users to init() instead.
write_notes() and write_readme() have been removed. These files are now
included in the project template downloaded by init().
write_ignore() no longer accepts an aggressive parameter. A single
.gitignore is provided.
settings() and brand_settings() have been removed. Use
write_variables() and write_brand() to create and edit configuration
files directly. These functions now handle existing files gracefully
(opening them for editing instead of erroring) and print reference URLs
to the console.
The your-metadata-your-way and building-your-brand-identity vignettes
have been removed.
New function init() is the primary entry point for creating froggeR
projects. It downloads the latest project scaffold from the companion
frogger-templates
repository and retrieves saved user configuration (_variables.yml,
_brand.yml, logos/) from ~/.config/froggeR/. The target directory is
created automatically if it does not exist. Existing files are never
overwritten, and each created or skipped file is reported individually.
write_scss() gains a filename parameter (default "custom"). A www/
prefix and .scss extension are stripped automatically, so
write_scss("tables") and write_scss("www/tables.scss") are equivalent.
Template architecture: Project templates now live in a separate repository
(kyleGrealis/frogger-templates), decoupled from CRAN release cycles. Template
improvements reach users immediately without a package update.
quarto, glue, readr, and stringr packages have been removed from
Imports.All template files previously bundled in inst/gists/ have been removed.
All templates are now fetched from the companion repository at runtime.
New internal helper .fetch_template() downloads individual files from the
template repository.
New internal helper .restore_saved_config() handles copying global user
configuration into new projects during init().
New function brand_settings() for interactive branding configuration (name,
colors, logos, typography). Saved to project-level, global, or both.
New function save_brand() for saving brand configuration to global settings.
settings() redesigned with interactive metadata workflow, input validation,
and project/global save options.
write_brand() gains restore_logos argument.
settings() and brand_settings().config.yml to _variables.yml.write_* functions: public API delegates to internal create_*
workers. Standardized error handling with rlang::abort() and custom classes.NEWS and vignettes. No functionality changes!write_quarto() argument custom_yaml has been replaced with example, defaulting to TRUE. The Quarto file templates have been reworked to use Quarto brand structure. This simplifies the YAML within the document, but may require changes to the project _quarto.yml and _brand.yml files.write_brand() & save_brand(). These functions allow users to add project _brand.yml file and save the current _brand.yml to where your machine stores configuration files. There are added arguments to save & restore your brand logos (saved as logos/ directory)._brand.yml file. Added tweaks for ORCID logo issue when rendering with branding on Windows..Rproj file in quarto_project().write_variables() that caused unintentional stoppage.save_variables() is a new function to store the current project-level _variables.yml to the system configuration file path. It offers to overwrite if the system config exists.affiliations in the standard, non-custom Quarto template. Created rendering error.save_variables() documentation added to READMEwrite_notes() and write_readme() to reflect updated content.settings() function replaces froggeR_settings and provides a menu-driven interface. Users can now check, view, and get instructions to use Quarto metadata within and across projects. Learn how to apply user-specific metadata from the global config file, or store local project metadata for reuse on future froggeR Quarto projects.write_* functions open the created files for immediate viewing & editing (in interactive sessions).@examples by using tempdir() when executing functions.@inheretParams across supplemental functions (README, notes, ignore, SCSS, variables).write_variables(), the config file is opened in the interactive session.write_readme; now includes write_notes for a project-level progress notes template.write_* functions exists in the project, froggeR will now stop and provide a useful message instead of offering to overwrite from the console. This reduces annoying feedback & interaction and encourages the user to make deliberate decisions.quarto_project():
write_variables() for managing _variables.yml.write_quarto():
write_variables() for _variables.yml creation.write_variables():
_variables.yml files in a modular way.Improved User Feedback:
ui_done and ui_info outputs.check() errors related to undefined global variables in examples._variables.yml creation would fail under specific directory conditions.write_quarto(), quarto_project(), and write_variables() with detailed examples and explanations.helpers.R for better maintainability and organization.write_scss() function for more streamlined YAML updates in Quarto documents.froggeR_settings() function, providing clearer output of current settings.default parameter to custom_yaml in quarto_project() and write_quarto() for clarity.froggeR_settings() to use YAML for configuration storage.~/.config/froggeR/config.yml.froggeR_settings() function.quarto_project() and write_quarto() to use the new YAML-based settings..check_settings() function to provide user feedback on incomplete settings..update_variables_yml() function to handle both creation and updating of _variables.yml.load_data() function and related utilities.Implemented enhanced Quarto project creation with quarto_project()
Added interactive YAML configuration via froggeR_settings()
Created document generation tools
write_quarto() for consistent document creationwrite_readme() for structured project documentationwrite_ignore() for enhanced Git securitywrite_scss() for custom styling templates