write_notes: Create a project README file

In rUM: R Templates from the University of Miami

Create a project README file

Description

This function streamlines project documentation by creating and managing both README.md and dated_progress_notes.md files. It provides interactive prompts for existing files and maintains consistent project documentation structure.

Usage

write_notes(path = here::here())

Arguments

path	The destination directory for the progress notes file. Defaults to here::here().

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

Creates a chronological project progress notes tracker

Examples

# Create new progress note file in temporary directory
tmp <- tempdir()
write_notes(path = tmp)

rUM documentation built on April 4, 2025, 3:02 a.m.