use_readme_rmd: Generate a README.Rmd

In golem: A Framework for Robust Shiny Applications

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 utils::file.edit() otherwise.
pkg_name	The name of the package
overwrite	an optional logical flag; if TRUE, overwrite existing README.Rmd, else throws an error if README.Rmd exists
pkg	Path to the root of the package. Default is get_golem_wd().

Value

pure side-effect function that generates template README.Rmd

golem documentation built on Sept. 11, 2024, 7:54 p.m.