Skip to contents

Create a package for a Shiny App using {golem}

Source: R/create_golem.R
create_golem.Rd

Create a package for a Shiny App using {golem}

Usage

create_golem(
  path,
  check_name = TRUE,
  open = TRUE,
  overwrite = FALSE,
  package_name = basename(normalizePath(path, mustWork = FALSE)),
  without_comments = FALSE,
  project_hook = golem::project_hook,
  with_git = FALSE,
  with_agents = FALSE,
  with_agents_options = NULL,
  ...
)

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?

overwrite

Boolean. Should the already existing project be deleted and replaced?

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.

with_git

Boolean. Initialize git repository

with_agents

Boolean. If TRUE, the fresh package is initialized with skills files and CLAUDE/AGENTS.md

with_agents_options

named list of options passed to use_skills(); list names must match use_skills() argument names except golem_wd and interactive.

...

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.