Skip to contents

Create a Dated Progress Notes File

Source: R/write_notes.R
write_notes.Rd

This function streamlines project documentation by creating a dated progress notes file and opening it for editing.

Usage

write_notes(path = here::here())

Arguments

path

Character. Path to the project directory. Default is current project root via here.

Value

Invisibly returns the file path after creating a dated progress notes file.

Details

The dated_progress_notes.md file is initialized with the current date and is designed to help track project milestones chronologically. This file supports markdown formatting for rich documentation of project progress.

See also

quarto_project, write_readme

Examples

# Create a temporary directory for testing
tmp_dir <- tempdir()

# Write the progress notes file
write_notes(path = tmp_dir)
#> ✔ Created dated_progress_notes.md

# Confirm the file was created
file.exists(file.path(tmp_dir, "dated_progress_notes.md"))
#> [1] TRUE

# Clean up
unlink(file.path(tmp_dir, "dated_progress_notes.md"))