Creates an rmarkdown README file that autofills using metadata from the
R package DESCRIPTION file.
use_readme(
save_dir = here::here(),
path = file.path(save_dir, "README.Rmd"),
force_new = FALSE,
show = FALSE,
verbose = TRUE
)
Arguments
- save_dir
Directory to save the file to.
- path
Path to the file.
- force_new
If the file already exists, overwrite it
(default: FALSE).
- show
Print the contents of the file in the R console.
- verbose
Print messages.
Value
Path to README file.
Examples
## use default save_dir in practice
path <- use_readme(save_dir = tempdir())
#> Creating new README file ==> /tmp/RtmppaN4bb/README.Rmd