use_readme_qmd: Creates skeleton README files

In benmarwick/rrtools: Creates a Reproducible Research Compendium

Creates skeleton README files

Description

README.qmd will be automatically added to .Rbuildignore. The resulting README is populated with default YAML frontmatter and R fenced code chunks (qmd). 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_qmd(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.qmd be directly rendered to a github markdown document? default: TRUE

Examples

## Not run: 
use_readme_qmd()

## End(Not run)

benmarwick/rrtools documentation built on Oct. 16, 2024, 11:54 a.m.