Generate a README.Rmd

Generate a README.Rmd

Usage

use_readme_rmd(  open=rlang::is_interactive(),  pkg_name=golem::get_golem_name(),  overwrite=FALSE,  golem_wd=golem::get_golem_wd(),pkg)

Arguments

open

Open the newly created file for editing? Happens in RStudio, ifapplicable, or viautils::file.edit() otherwise.

pkg_name

The name of the package

overwrite

an optionallogical flag; ifTRUE, overwriteexistingREADME.Rmd, else throws an error ifREADME.Rmd exists

golem_wd

Path to the root of the package. Default isget_golem_wd().

pkg

Deprecated, please use golem_wd instead

Value

pure side-effect function that generates templateREADME.Rmd