This function is designed to first check for the existence of a README file. If none is detected or the user chooses to overwrite the current README, a README template is loaded from https://gist.github.com/kyleGrealis and written to the project level.
Usage
write_readme(path = getwd())Value
A README.md template. Contains sections for:
* Project description (study name, principal investigator, & author)
* Project setup steps for ease of portability
* Project file descriptions
* Project directory descriptions
* Miscellaneous
Details
This function handles the creation and/or overwriting of both README.md
and dated_progress_notes.md files. For each file, if it already exists,
the user will be prompted whether to overwrite it. The dated_progress_notes.md
file will be initialized with the current date and a "project started" message.
NOTE: Some documentation remains to provide the user with example descriptions for files & directories. It is highly recommended to keep these sections. However, this is a modifiable template and should be tailor-fit for your exact purpose.
Examples
if (FALSE) { # \dontrun{
# Create a new temporary directory for the example
temp_dir <- tempdir()
write_readme(path = temp_dir)
} # }