rrtools (version 0.1.5)

use_readme_rmd: Creates skeleton README files

Description

README.Rmd will be automatically added to .Rbuildignore. The resulting README is populated with default YAML frontmatter and R fenced code chunks (Rmd). Your readme should contain:

• a high-level description of the package and its goals

• R code to install from GitHub, if GitHub usage detected

• a basic example

Usage

use_readme_rmd(pkg = ".", render_readme = TRUE)

Arguments

pkg

package description, can be path or package name. See as.package for more information

render_readme

should the README.Rmd be directly rendered to a github markdown document? default: TRUE

Examples

# NOT RUN {
use_readme_rmd()
# }