pkgreview_index_rmd: Create review templates.

View source: R/render-templates.R

pkgreview_index_rmdR Documentation

Create review templates.

Description

Creates skeleton review files:

  • index.Rmd: html_notebook to perform and record review in

  • README.md: prepopulated README for review repo.

index.Rmd will be automatically added to .Rbuildignore. The resulting templates are populated with default YAML frontmatter and R fenced code chunks (Rmd).

Usage

pkgreview_index_rmd(pkg_data, template = c("review", "editor"))

pkgreview_readme_md(pkg_data)

pkgreview_request(pkg_data)

Arguments

pkg_data

package metadata generated by pkgreview_getdata()

template

character string, one of review or editor.

Examples

## Not run: 
pkg_data <- pkgreview_getdata(pkg_dir)
pkgreview_index_rmd(pkg_data)
pkgreview_readme_md(pkg_data)

## End(Not run)

annakrystalli/pkgreviewr documentation built on Sept. 12, 2023, 5:35 p.m.