write_notes {froggeR} | R Documentation |
Create a project README file
Description
This function streamlines project documentation by creating a dated progress notes file.
Usage
write_notes(path = here::here(), .initialize_proj = FALSE)
Arguments
path |
Character string. Path to the project directory. |
.initialize_proj |
Logical. TRUE only if starting a
|
Details
The dated_progress_notes.md file is initialized with the current date and is designed to help track project milestones chronologically. If the progress notes file already exists, the function will stop and warn the user.
Value
CA chronological project progress notes tracker.
Examples
# Create a temporary directory for testing
tmp_dir <- tempdir()
# Write the progress notes file
write_notes(path = tmp_dir)
# Confirm the file was created (optional, for user confirmation)
file.exists(file.path(tmp_dir, "dated_progress_notes.md"))
# Clean up: Remove the created file
unlink(file.path(tmp_dir, "dated_progress_notes.md"))
[Package froggeR version 0.4.0 Index]