Create and update a custom README.Rmd with installation instructions

Create and update a custom README.Rmd with installation instructions

generate_readme_rmd(
  base_path = usethis::proj_get(),
  parts = c("description", "installation"),
  source = c("archive", "github", "git"),
  edit = TRUE,
  url
)

Arguments

base_path

Path of the package to generate Readme from

parts

Parts to modify in the Readme: c("description", "installation")

source

Will the package be delivered as archive, from github or from another git?

edit

Logical. Whether to open README.Rmd

url

url of the repository if not in URL in DESCRIPTION. Used when source is github or git.

Value

A README.Rmd file

Examples

if (FALSE) {
generate_readme_rmd()
}