create_golem: Create a package for a Shiny App using '{golem}'

Description Usage Arguments Value Note

View source: R/create_golem.R

Description

Create a package for a Shiny App using {golem}

Usage

1
2
3
4
5
6
7
8
9
create_golem(
  path,
  check_name = TRUE,
  open = TRUE,
  package_name = basename(path),
  without_comments = FALSE,
  project_hook = golem::project_hook,
  ...
)

Arguments

path

Name of the folder to create the package in. This will also be used as the package name.

check_name

Should we check that the package name is correct according to CRAN requirements.

open

Boolean. Open the created project?

package_name

Package name to use. By default, golem uses basename(path). If path == '.' & package_name is not explicitly set, then basename(getwd()) will be used.

without_comments

Boolean. Start project without golem comments

project_hook

A function executed as a hook after project creation. Can be used to change the default {golem} structure. to override the files and content. This function is executed just after the project is created.

...

Arguments passed to the project_hook() function.

Value

The path, invisibly.

Note

For compatibility issue, this function turns options(shiny.autoload.r) to FALSE. See https://github.com/ThinkR-open/golem/issues/468 for more background.


golem documentation built on April 17, 2021, 9:06 a.m.