use_readme_rmd {golem} | R Documentation |
Generate a README.Rmd
Description
Generate a README.Rmd
Usage
use_readme_rmd(
open = rlang::is_interactive(),
pkg_name = golem::get_golem_name(),
overwrite = FALSE,
pkg = golem::get_golem_wd()
)
Arguments
open |
Open the newly created file for editing? Happens in RStudio, if
applicable, or via |
pkg_name |
The name of the package |
overwrite |
an optional |
pkg |
Path to the root of the package. Default is |
Value
pure side-effect function that generates template README.Rmd
[Package golem version 0.5.1 Index]