use_readme_rmd

An opinionated framework for building a production-ready
'Shiny' application. This package contains a series of tools for
building a robust 'Shiny' application from start to finish.

Colin FAY

golem

A Framework for Robust Shiny Applications

Colin Fay

Vincent Guyader

Sébastien Rochette

Cervan Girard

Novica Nakov

David Granjon

Arthur Bréant

Antoine Languillaume

Ilya Zarubin

ThinkR 

use_readme_rmd function

<dl><dt>open</dt>
<dd>Open the newly created file for editing? Happens in RStudio, if
applicable, or via <code><a href="/link/utils%3A%3Afile.edit()?package=golem&version=0.5.1" data-mini-rdoc="golem::utils::file.edit()">utils::file.edit()</a></code> otherwise.</dd>
<dt>pkg_name</dt>
<dd>The name of the package</dd>
<dt>overwrite</dt>
<dd>an optional <code>logical</code> flag; if <code>TRUE</code>, overwrite
existing <code>README.Rmd</code>, else throws an error if <code>README.Rmd</code> exists</dd>
<dt>pkg</dt>
<dd>Path to the root of the package. Default is <code>get_golem_wd()</code>.</dd></dl>

Arguments

Generate a README.Rmd — use_readme_rmd

<dl>

<dt>open</dt>
<dd>Open the newly created file for editing? Happens in RStudio, if
applicable, or via <code><a href='https://rdrr.io/r/utils/file.edit.html'>utils::file.edit()</a></code> otherwise.</dd>


<dt>pkg_name</dt>
<dd>The name of the package</dd>


<dt>overwrite</dt>
<dd>an optional <code>logical</code> flag; if <code>TRUE</code>, overwrite
existing <code>README.Rmd</code>, else throws an error if <code>README.Rmd</code> exists</dd>


<dt>pkg</dt>
<dd>Path to the root of the package. Default is <code>get_golem_wd()</code>.</dd>

</dl>

Generate a README.Rmd

use_readme_rmd: Generate a README.Rmd

Description

Usage

Value

Arguments