use_open_pkgdown: Create an 'open_pkgdown' function

Description Usage Arguments Value

View source: R/open_pkgdown.R

Description

Create an open_pkgdown function

Usage

1
2
3
4
5
6
use_open_pkgdown(
  pkgname = NULL,
  save_as = "R/open_pkgdown.R",
  Rcreate = FALSE,
  ...
)

Arguments

pkgname

package name

...

Arguments passed on to usethis::use_template

template

Path to template file relative to templates/ directory within package; see details.

save_as

Path of file to create, relative to root of active project. Defaults to template

data

A list of data passed to the template.

ignore

Should the newly created file be added to .Rbuildignore?

open

Open the newly created file for editing? Happens in RStudio, if applicable, or via utils::file.edit() otherwise.

package

Name of the package where the template is found.

create

logical - should pkgdown be created?

Value

invisible


jimbrig/jimstemplates documentation built on Dec. 21, 2021, 12:05 a.m.