update_readme_rmd: Update README.Rmd template

In leonawicz/pkgpeanuts: Automate Robust R Package Scaffolding Setup

Description

Update the README.Rmd template file created by usethis::use_readme_rmd.

Usage

update_readme_rmd(repo, host = "github", public = TRUE)

Arguments

repo	character, the repository name, e.g. leonawicz/pkgpeanuts.
host	character, options are "github" or "bitbucket".
public,	logical, whether the remote repository is public or private.

Details

The file must exist. This function is for updating the Rmd file, not an md file. It replaces the content in the Installation section of the original template. Replacement content is conditional on host and whether or not public is TRUE or FALSE. The package name is also inserted as needed, taken from repo.

Value

side effect of updating file.

Examples

## Not run: update_readme_rmd

leonawicz/pkgpeanuts documentation built on June 7, 2019, 2:56 a.m.