Package {golem}

Title:	A Framework for Robust Shiny Applications
Version:	1.0.0
Description:	An opinionated framework for building a production-ready 'Shiny' application. This package contains a series of tools for building a robust 'Shiny' application from start to finish.
License:	MIT + file LICENSE
URL:	https://thinkr-open.github.io/golem/, https://github.com/ThinkR-open/golem
BugReports:	https://github.com/ThinkR-open/golem/issues
Depends:	R (≥ 3.5.0)
Imports:	attempt (≥ 0.3.0), codetools, config, htmltools, rlang (≥ 1.0.0), shiny (≥ 1.5.0), utils, yaml
Suggests:	attachment (≥ 0.3.2), callr, cli (≥ 2.0.0), covr, desc, devtools, dockerfiler (≥ 0.2.5), fs, httpuv, knitr, lifecycle, mockery, pkgbuild, pkgdown, pkgload (≥ 1.3.0), processx, purrr, rcmdcheck, remotes, renv, rmarkdown, roxygen2, rsconnect, rstudioapi, sass, spelling, stringr, testthat (≥ 3.0.0), tools, usethis (≥ 1.6.0), withr
VignetteBuilder:	knitr
Config/testthat/edition:	3
Encoding:	UTF-8
Language:	en-US
Config/roxygen2/version:	8.0.0
RoxygenNote:	8.0.0
NeedsCompilation:	no
Packaged:	2026-06-25 13:43:57 UTC; colinfay
Author:	Colin Fay [cre, aut], Vincent Guyader [aut] (previous maintainer), Sébastien Rochette [aut], Cervan Girard [aut], Novica Nakov [ctb], David Granjon [ctb], Arthur Bréant [ctb], Antoine Languillaume [ctb], Ilya Zarubin [ctb], ThinkR [cph]
Maintainer:	Colin Fay <contact@colinfay.me>
Repository:	CRAN
Date/Publication:	2026-06-26 08:40:02 UTC

A package for building Shiny App

Description

Read more about building big shiny apps at https://engineering-shiny.org/.

Author(s)

Maintainer: Colin Fay contact@colinfay.me (ORCID)

Authors:

• Colin Fay contact@colinfay.me (ORCID)

• Vincent Guyader vincent@thinkr.fr (ORCID) (previous maintainer)

• Sébastien Rochette sebastien@thinkr.fr (ORCID)

• Cervan Girard cervan@thinkr.fr (ORCID)

Other contributors:

• Novica Nakov nnovica@gmail.com [contributor]

• David Granjon dgranjon@ymail.com [contributor]

• Arthur Bréant arthur@thinkr.fr [contributor]

• Antoine Languillaume antoine@thinkr.fr [contributor]

• Ilya Zarubin zarubin@wiso.uni-koeln.de [contributor]

• ThinkR [copyright holder]

See Also

Useful links:

• https://thinkr-open.github.io/golem/

• https://github.com/ThinkR-open/golem

• Report bugs at https://github.com/ThinkR-open/golem/issues

Interact with JavaScript built-in Functions

Description

activate_js is used to insert directly some JavaScript functions in your golem. By default bundle_ressources() load these function automatically for you.

Usage

activate_js()

invoke_js(fun, ..., session = shiny::getDefaultReactiveDomain())

Arguments

Details

These JavaScript functions can be called from the server with invoke_js. invoke_js can also be used to launch any JS function created inside a Shiny JavaScript handler.

Value

Used for side-effects.

Examples

if (interactive()) {
  library(shiny)
  ui <- fluidPage(
    golem::activate_js(), # already loaded in your golem by `bundle_resources()`
    fluidRow(
      actionButton(inputId = "hidebutton1", label = "hide button1"),
      actionButton(inputId = "showbutton1", label = "show button1"),
      actionButton(inputId = "button1", label = "button1")
    ),
    fluidRow(
      actionButton(inputId = "hideclassA", label = "hide class A"),
      actionButton(inputId = "showclassA", label = "show class A"),
      actionButton(inputId = "buttonA1", label = "button A1", class = "A"),
      actionButton(inputId = "buttonA2", label = "button A2", class = "A"),
      actionButton(inputId = "buttonA3", label = "button A3", class = "A")
    ),
    fluidRow(
      actionButton(inputId = "clickhide", label = "click on 'hide button1' and 'hide class A'"),
      actionButton(inputId = "clickshow", label = "click on 'show button1' and 'show class A'")
    ),
    fluidRow(
      actionButton(inputId = "disableA", label = "disable class A"),
      actionButton(inputId = "reableA", label = "reable class A")
    ),
    fluidRow(
      actionButton(inputId = "alertbutton", label = "alert button"),
      actionButton(inputId = "promptbutton", label = "prompt button"),
      actionButton(inputId = "confirmbutton", label = "confirm button")
    )
  )

  server <- function(input, output, session) {
    observeEvent(input$hidebutton1, {
      golem::invoke_js("hideid", "button1")
    })

    observeEvent(input$showbutton1, {
      golem::invoke_js("showid", "button1")
    })

    observeEvent(input$hideclassA, {
      golem::invoke_js("hideclass", "A")
    })
    observeEvent(input$showclassA, {
      golem::invoke_js("showclass", "A")
    })

    observeEvent(input$clickhide, {
      golem::invoke_js("clickon", "#hidebutton1")
      golem::invoke_js("clickon", "#hideclassA")
    })

    observeEvent(input$clickshow, {
      golem::invoke_js("clickon", "#showbutton1")
      golem::invoke_js("clickon", "#showclassA")
    })

    observeEvent(input$disableA, {
      golem::invoke_js("disable", ".A")
    })
    observeEvent(input$reableA, {
      golem::invoke_js("reable", ".A")
    })

    observeEvent(input$alertbutton, {
      golem::invoke_js("alert", "ALERT!!")
    })

    observeEvent(input$promptbutton, {
      golem::invoke_js("prompt", list(message = "what's your name?", id = "name"))
    })
    observeEvent(input$name, {
      message(paste("input$name", input$name))
    })

    observeEvent(input$confirmbutton, {
      golem::invoke_js("confirm", list(message = "Are you sure?", id = "sure"))
    })
    observeEvent(input$sure, {
      message(paste("input$sure", input$sure))
    })
  }
  shinyApp(ui, server)
}

Create a Dockerfile for your App

Description

Build a container containing your Shiny App. add_dockerfile() and add_dockerfile_with_renv() and add_dockerfile_with_renv() creates a generic Dockerfile, while add_dockerfile_shinyproxy(), add_dockerfile_with_renv_shinyproxy() , add_dockerfile_with_renv_shinyproxy() and add_dockerfile_heroku() creates platform specific Dockerfile.

Usage

add_dockerfile(
  path = "DESCRIPTION",
  output = "Dockerfile",
  golem_wd = get_golem_wd(),
  from = paste0("rocker/verse:", R.Version()$major, ".", R.Version()$minor),
  as = NULL,
  port = 80,
  host = "0.0.0.0",
  sysreqs = TRUE,
  repos = c(CRAN = "https://cran.rstudio.com/"),
  expand = FALSE,
  open = TRUE,
  update_tar_gz = TRUE,
  build_golem_from_source = TRUE,
  extra_sysreqs = NULL,
  pkg
)

add_dockerfile_shinyproxy(
  path = "DESCRIPTION",
  output = "Dockerfile",
  golem_wd = get_golem_wd(),
  from = paste0("rocker/verse:", R.Version()$major, ".", R.Version()$minor),
  as = NULL,
  sysreqs = TRUE,
  repos = c(CRAN = "https://cran.rstudio.com/"),
  expand = FALSE,
  open = TRUE,
  update_tar_gz = TRUE,
  build_golem_from_source = TRUE,
  extra_sysreqs = NULL,
  pkg
)

add_dockerfile_heroku(
  path = "DESCRIPTION",
  output = "Dockerfile",
  golem_wd = get_golem_wd(),
  from = paste0("rocker/verse:", R.Version()$major, ".", R.Version()$minor),
  as = NULL,
  sysreqs = TRUE,
  repos = c(CRAN = "https://cran.rstudio.com/"),
  expand = FALSE,
  open = TRUE,
  update_tar_gz = TRUE,
  build_golem_from_source = TRUE,
  extra_sysreqs = NULL,
  pkg
)

add_dockerfile_with_renv(
  golem_wd = get_golem_wd(),
  lockfile = NULL,
  output_dir = fs::path(tempdir(), "deploy"),
  distro = "focal",
  from = "rocker/verse",
  as = "builder",
  sysreqs = TRUE,
  port = 80,
  host = "0.0.0.0",
  repos = c(CRAN = "https://cran.rstudio.com/"),
  expand = FALSE,
  open = TRUE,
  document = TRUE,
  extra_sysreqs = NULL,
  update_tar_gz = TRUE,
  dockerfile_cmd = NULL,
  user = "rstudio",
  single_file = TRUE,
  set_golem.app.prod = TRUE,
  ...,
  source_folder
)

add_dockerfile_with_renv_shinyproxy(
  golem_wd = get_golem_wd(),
  lockfile = NULL,
  output_dir = fs::path(tempdir(), "deploy"),
  distro = "focal",
  from = "rocker/verse",
  as = NULL,
  sysreqs = TRUE,
  repos = c(CRAN = "https://cran.rstudio.com/"),
  expand = FALSE,
  extra_sysreqs = NULL,
  open = TRUE,
  document = TRUE,
  update_tar_gz = TRUE,
  user = "rstudio",
  single_file = TRUE,
  set_golem.app.prod = TRUE,
  ...,
  source_folder
)

add_dockerfile_with_renv_heroku(
  golem_wd = get_golem_wd(),
  lockfile = NULL,
  output_dir = fs::path(tempdir(), "deploy"),
  distro = "focal",
  from = "rocker/verse",
  as = NULL,
  sysreqs = TRUE,
  repos = c(CRAN = "https://cran.rstudio.com/"),
  expand = FALSE,
  extra_sysreqs = NULL,
  open = TRUE,
  document = TRUE,
  user = "rstudio",
  update_tar_gz = TRUE,
  single_file = TRUE,
  set_golem.app.prod = TRUE,
  ...,
  source_folder
)

Arguments

FROM rocker/verse

without renv.lock file passed
`R.Version()$major`.`R.Version()$minor` is used as tag

Value

The {dockerfiler} object, invisibly.

Note

add_dockerfile(), add_dockerfile_shinyproxy(), and add_dockerfile_heroku() are now soft deprecated; use the corresponding ⁠add_dockerfile_with_renv_*()⁠ functions instead.

Examples

# Add a standard Dockerfile
if (interactive() & requireNamespace("dockerfiler")) {
  add_dockerfile()
}
# Crete a 'deploy' folder containing everything needed to deploy
# the golem using docker based on {renv}
if (interactive() & requireNamespace("dockerfiler")) {
  add_dockerfile_with_renv(
    # lockfile = "renv.lock", # uncomment to use existing renv.lock file
    output_dir = "deploy"
  )
}
# Add a Dockerfile for ShinyProxy
if (interactive() & requireNamespace("dockerfiler")) {
  add_dockerfile_shinyproxy()
}

# Crete a 'deploy' folder containing everything needed to deploy
# the golem with ShinyProxy using docker based on {renv}
if (interactive() & requireNamespace("dockerfiler")) {
  add_dockerfile_with_renv(
    # lockfile = "renv.lock",# uncomment to use existing renv.lock file
    output_dir = "deploy"
  )
}

# Add a Dockerfile for Heroku
if (interactive() & requireNamespace("dockerfiler")) {
  add_dockerfile_heroku()
}

Add fct_ and utils_ files

Description

These functions add files in the R/ folder that starts either with fct_ (short for function) or with utils_.

Usage

add_fct(
  name,
  module = NULL,
  golem_wd = get_golem_wd(),
  open = TRUE,
  dir_create = TRUE,
  with_test = FALSE,
  template = fct_template,
  ...,
  pkg
)

add_utils(
  name,
  module = NULL,
  golem_wd = get_golem_wd(),
  open = TRUE,
  dir_create = TRUE,
  with_test = FALSE,
  pkg
)

add_r6(
  name,
  module = NULL,
  golem_wd = get_golem_wd(),
  open = TRUE,
  dir_create = TRUE,
  with_test = FALSE,
  pkg
)

Arguments

Value

The path to the file, invisibly.

Add deployment CI for GitHub Actions

Description

Creates a minimal GitHub Actions workflow for deploying a {golem} app to Posit Connect via {rsconnect}. If needed, this function also creates a root app.R and .rscignore by calling add_positconnect_file(). The generated Posit Connect entrypoint uses {pkgload}, so {pkgload} is added to DESCRIPTION.

Usage

add_github_action(golem_wd = get_golem_wd(), open = TRUE)

Arguments

Value

The path to the created workflow, invisibly.

Add deployment CI for GitLab

Description

Creates a minimal GitLab CI file for deploying a {golem} app to Posit Connect via {rsconnect}. If needed, this function also creates a root app.R and .rscignore by calling add_positconnect_file(). The generated Posit Connect entrypoint uses {pkgload}, so {pkgload} is added to DESCRIPTION.

Usage

add_gitlab_ci(golem_wd = get_golem_wd(), open = TRUE)

Arguments

Value

The path to the created GitLab CI file, invisibly.

Create Files

Description

These functions create files inside the inst/app folder.

Usage

add_js_file(
  name,
  golem_wd = get_golem_wd(),
  dir = "inst/app/www",
  open = TRUE,
  dir_create,
  with_doc_ready = TRUE,
  template = golem::js_template,
  ...,
  pkg
)

add_js_handler(
  name,
  golem_wd = get_golem_wd(),
  dir = "inst/app/www",
  open = TRUE,
  dir_create,
  template = golem::js_handler_template,
  ...,
  pkg
)

add_js_input_binding(
  name,
  golem_wd = get_golem_wd(),
  dir = "inst/app/www",
  open = TRUE,
  dir_create,
  initialize = FALSE,
  dev = FALSE,
  events = list(name = c("change", "input"), rate_policy = c(FALSE, FALSE)),
  pkg
)

add_js_output_binding(
  name,
  golem_wd = get_golem_wd(),
  dir = "inst/app/www",
  open = TRUE,
  dir_create,
  pkg
)

add_css_file(
  name,
  golem_wd = get_golem_wd(),
  dir = "inst/app/www",
  open = TRUE,
  dir_create,
  template = golem::css_template,
  ...,
  pkg
)

add_sass_file(
  name,
  golem_wd = get_golem_wd(),
  dir = "inst/app/www",
  open = TRUE,
  dir_create,
  template = golem::sass_template,
  ...,
  pkg
)

add_empty_file(
  name,
  golem_wd = get_golem_wd(),
  dir = "inst/app/www",
  open = TRUE,
  dir_create,
  template = golem::empty_template,
  ...,
  pkg
)

add_html_template(
  name = "template.html",
  golem_wd = get_golem_wd(),
  dir = "inst/app/www",
  open = TRUE,
  dir_create,
  pkg
)

add_partial_html_template(
  name = "partial_template.html",
  golem_wd = get_golem_wd(),
  dir = "inst/app/www",
  open = TRUE,
  dir_create,
  pkg
)

add_ui_server_files(
  golem_wd = get_golem_wd(),
  dir = "inst/app",
  dir_create,
  pkg
)

Arguments

Value

The path to the file, invisibly.

Note

add_ui_server_files will be deprecated in future version of {golem}

See Also

js_template, js_handler_template, and css_template

Create a module

Description

This function creates a module inside the ⁠R/⁠ folder, based on a specific module structure. This function can be used outside of a {golem} project.

Usage

add_module(
  name,
  golem_wd = get_golem_wd(),
  open = TRUE,
  dir_create = TRUE,
  fct = NULL,
  utils = NULL,
  r6 = NULL,
  js = NULL,
  js_handler = NULL,
  export = FALSE,
  module_template = golem::module_template,
  with_test = FALSE,
  ...,
  pkg
)

Arguments

Value

The path to the file, invisibly.

Note

This function will prefix the name argument with mod_.

See Also

module_template()

Add an app.R at the root of your package to deploy on RStudio Connect

Description

Additionally, adds a .rscignore at the root of the {golem} project if the rsconnect package version is ⁠>= 0.8.25⁠.

Usage

add_positconnect_file(golem_wd = get_golem_wd(), open = TRUE, pkg)

add_shinyappsio_file(golem_wd = get_golem_wd(), open = TRUE, pkg)

add_shinyserver_file(golem_wd = get_golem_wd(), open = TRUE, pkg)

add_rscignore_file(golem_wd = get_golem_wd(), open = TRUE, pkg)

Arguments

Value

Side-effect functions for file creation returning the path to the file, invisibly.

List of excluded files in .rscignore

• .here

• CODE_OF_CONDUCT.md

• LICENSE{.md}

• LICENCE{.md}

• NEWS{.md}

• README{.md,.Rmd,.HTML}

• dev

• man

• tests

• vignettes

Note

In previous versions, this function was called add_rconnect_file.

Examples

# Add a file for Connect
if (interactive()) {
  add_positconnect_file()
}
# Add a file for Shiny Server
if (interactive()) {
  add_shinyserver_file()
}
# Add a file for Shinyapps.io
if (interactive()) {
  add_shinyappsio_file()
}

Add resource path

Description

Add resource path

Usage

add_resource_path(prefix, directoryPath, warn_empty = FALSE)

Arguments

Value

Used for side effects.

{golem} addins

Description

insert_ns() takes a selected character vector and wrap it in ns() The series of ⁠go_to_*()⁠ addins help you go to common files used in developing a {golem} application.

Usage

insert_ns()

go_to_start(golem_wd = golem::get_golem_wd(), wd)

go_to_dev(golem_wd = golem::get_golem_wd(), wd)

go_to_deploy(golem_wd = golem::get_golem_wd(), wd)

go_to_run_dev(golem_wd = golem::get_golem_wd(), wd)

go_to_app_ui(golem_wd = golem::get_golem_wd(), wd)

go_to_app_server(golem_wd = golem::get_golem_wd(), wd)

go_to_run_app(golem_wd = golem::get_golem_wd(), wd)

Arguments

Amend golem config file

Description

Amend golem config file

Usage

amend_golem_config(
  key,
  value,
  config = "default",
  golem_wd = golem::pkg_path(),
  talkative = TRUE,
  pkg
)

Arguments

Value

Used for side effects.

Is the app in dev mode or prod mode?

Description

Is the app in dev mode or prod mode?

Usage

app_prod()

app_dev()

Value

TRUE or FALSE depending on the status of getOption( "golem.app.prod")

Insert an hidden browser button

Description

See https://rtask.thinkr.fr/a-little-trick-for-debugging-shiny/ for more context.

Usage

browser_button()

Value

Used for side effects. Prints the code to the console.

Note

browser_button() is now soft deprecated and will be removed in a future version of {golem}.

Automatically serve golem external resources

Description

This function is a wrapper around htmltools::htmlDependency that automatically bundles the CSS and JavaScript files in inst/app/www and which are created by golem::add_css_file() , golem::add_js_file() and golem::add_js_handler().

Usage

bundle_resources(
  path,
  app_title,
  name = "golem_resources",
  version = "0.0.1",
  meta = NULL,
  head = NULL,
  attachment = NULL,
  package = NULL,
  all_files = TRUE,
  app_builder = "golem",
  with_sparkles = FALSE,
  activate_js = TRUE
)

Arguments

Details

This function also preload activate_js() which allows to use preconfigured JavaScript functions via invoke_js().

Value

an htmlDependency

Functions already made dev dependent

Description

This functions will be run only if golem::app_dev() returns TRUE.

Usage

cat_dev(...)

print_dev(...)

message_dev(...)

warning_dev(...)

browser_dev(...)

Arguments

Value

A modified function.

Create a package for a Shiny App using {golem}

Description

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

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.

Detach all attached package

Description

Detach all attached package

Usage

detach_all_attached()

Value

TRUE, invisibly.

Disabling Shiny Autoload of R Scripts

Description

Disabling Shiny Autoload of R Scripts

Usage

disable_autoload(golem_wd = get_golem_wd(), pkg)

Arguments

Value

The path to the file, invisibly.

Examples

if (interactive()) {
  disable_autoload()
}

Document and reload your package

Description

This function calls rstudioapi::documentSaveAll(), roxygen2::roxygenise() and pkgload::load_all().

Usage

document_and_reload(
  golem_wd = get_golem_wd(),
  roclets = NULL,
  load_code = NULL,
  clean = FALSE,
  export_all = FALSE,
  helpers = FALSE,
  attach_testthat = FALSE,
  ...,
  pkg
)

Arguments

Value

Used for side-effects

Test helpers

Description

These functions are designed to be used inside the tests in your Shiny app package.

Usage

expect_shinytag(object)

expect_shinytaglist(object)

expect_html_equal(ui, html, ...)

expect_running(sleep, R_path = NULL)

Arguments

Details

expect_running() only checks that an app can be launched: it starts a background R process that runs run_app() and verifies that the process is still alive after sleep seconds. It does not request any page, exercise the server logic, or detect runtime errors that happen after start-up. A passing expect_running() therefore means "the app starts and stays up", not "the app works".

Value

A testthat result.

Golem Function Template

Description

Function templates can be used to extend the add_fct() creation mechanism with your own template, so that you can be even more productive when building your {shiny} app. Function template functions do not aim at being called as is by users, but to be passed as an argument to the add_fct() function.

Usage

fct_template(name, path, export = FALSE, ...)

Arguments

Details

A template function can take the following arguments to be passed from add_fct():

• name: the name of the function

• path: the path to the file in R/

• export: a TRUE/FALSE value

If you want your function to ignore these parameters, set ... as the last argument of your function, then these will be ignored. See the examples section of this help.

Value

Used for side effect

See Also

add_fct()

Examples

if (interactive()) {
  my_tmpl <- function(name, path, ...) {
    # Define a template that writes to the function file
    write(name, path)
  }
  golem::add_fct(name = "custom", template = my_tmpl)
}

Fill your DESCRIPTION file

Description

Generates a standard DESCRIPTION file as used in R packages. Also sets a series of global options inside golem-config.yml that will be reused inside {golem} (see set_options and set_golem_options() for details).

Usage

fill_desc(
  pkg_name,
  pkg_title,
  pkg_description,
  authors = person(given = NULL, family = NULL, email = NULL, role = NULL, comment =
    NULL),
  repo_url = NULL,
  pkg_version = "0.0.0.9000",
  pkg = get_golem_wd(),
  author_first_name = NULL,
  author_last_name = NULL,
  author_email = NULL,
  author_orcid = NULL,
  set_options = TRUE
)

Arguments

Value

The {desc} object, invisibly.

Return path to the {golem} config-file

Description

This function tries to find the current config file, being either inst/golem-config.yml or the GOLEM_CONFIG_PATH env var

Usage

get_current_config(path = getwd())

Arguments

Details

In most cases this function simply returns the path to the default golem-config file located under "inst/golem-config.yml". That config comes in yml-format, see the Engineering Production-Grade Shiny Apps for further details on its format and how to set options therein.

Advanced app developers may benefit from having an additional user config-file. This is achieved with setting the GOLEM_CONFIG_PATH env var.

Value

character string giving the path to the {golem} config-file

Get all or one golem options

Description

This function is to be used inside the server and UI from your app, in order to call the parameters passed to run_app().

Usage

get_golem_options(which = NULL)

Arguments

Value

The value of the option.

Examples

# Define and use golem_options
if (interactive()) {
  # 1. Pass parameters directly to `run_app`

  run_app(
    title = "My Golem App",
    content = "something"
  )

  # 2. Get the values
  # 2.1 from the UI side

  h1(get_golem_options("title"))

  # 2.2 from the server-side

  output$param <- renderPrint({
    paste("param content = ", get_golem_options("content"))
  })

  output$param_full <- renderPrint({
    get_golem_options() # list of all golem options as a list.
  })

  # 3. If needed, to set default value, edit `run_app` like this :

  run_app <- function(
  title = "this",
  content = "that",
  ...
  ) {
    with_golem_options(
      app = shinyApp(
        ui = app_ui,
        server = app_server
      ),
      golem_opts = list(
        title = title,
        content = content,
        ...
      )
    )
  }
}

{golem} options

Description

Set and get a series of options to be used with {golem}. These options are found inside the golem-config.yml file, found in most cases inside the inst folder.

Usage

get_golem_wd(use_parent = TRUE, golem_wd = golem::pkg_path(), pkg)

get_golem_name(
  config = Sys.getenv("GOLEM_CONFIG_ACTIVE", Sys.getenv("R_CONFIG_ACTIVE", "default")),
  use_parent = TRUE,
  golem_wd = golem::pkg_path(),
  pkg
)

get_golem_version(
  config = Sys.getenv("GOLEM_CONFIG_ACTIVE", Sys.getenv("R_CONFIG_ACTIVE", "default")),
  use_parent = TRUE,
  golem_wd = golem::pkg_path(),
  pkg
)

set_golem_name(
  name = golem::pkg_name(),
  golem_wd = golem::pkg_path(),
  talkative = TRUE,
  old_name = golem::pkg_name(),
  pkg
)

set_golem_version(
  version = golem::pkg_version(),
  golem_wd = golem::pkg_path(),
  talkative = TRUE,
  pkg
)

set_golem_options(
  golem_name = golem::pkg_name(),
  golem_version = golem::pkg_version(),
  golem_wd = golem::pkg_path(),
  app_prod = FALSE,
  talkative = TRUE,
  config_file = golem::get_current_config(golem_wd)
)

Arguments

Value

Used for side-effects for the setters, and values from the config in the getters.

Set Functions

• set_golem_options() sets all the options, with the defaults from the functions below.

• set_golem_wd() defaults to golem::golem_wd(), which is the package root when starting a golem.

• set_golem_name() defaults golem::pkg_name()

• set_golem_version() defaults golem::pkg_version()

Get Functions

Reads the information from golem-config.yml

• get_golem_wd()

• get_golem_name()

• get_golem_version()

Welcome Page

Description

Welcome Page

Usage

golem_welcome_page()

Value

A welcome page for your {golem} app

Install {golem} dev dependencies

Description

This function will run rlang::check_installed() on:

• usethis

• pkgload

• dockerfiler

• devtools

• roxygen2

• attachment

• rstudioapi

• fs

• desc

• pkgbuild

• processx

• rsconnect

• testthat

Usage

install_dev_deps(dev_deps, force_install = FALSE, ...)

Arguments

Value

Used for side-effects

Examples

if (interactive()) {
  install_dev_deps()
}

Is the directory a golem-based app?

Description

Trying to guess if path is a golem-based app.

Usage

is_golem(path = getwd())

Arguments

Value

A boolean, TRUE if the directory is a golem-based app, FALSE else.

Examples

is_golem()

Is the running app a golem app?

Description

Note that this will return TRUE only if the application has been launched with with_golem_options()

Usage

is_running()

Value

TRUE if the running app is a {golem} based app, FALSE otherwise.

Examples

is_running()

Golem's default custom templates

Description

These functions do not aim at being called as is by users, but to be passed as an argument to the add_js_handler() function.

Usage

js_handler_template(path, name = "fun", code = " ")

js_template(path, code = " ")

css_template(path, code = " ")

sass_template(path, code = " ")

empty_template(path, code = " ")

Arguments

Value

Used for side effect

See Also

add_js_handler()

maintenance_page

Description

A default html page for maintenance mode

Usage

maintenance_page()

Details

see the vignette vignette("f_extending_golem", package = "golem") for details.

Value

an html_document

Make a function dependent to dev mode

Description

The function returned will be run only if golem::app_dev() returns TRUE.

Usage

make_dev(fun)

Arguments

Value

Used for side-effects

Golem Module Template Function

Description

Module template can be used to extend golem module creation mechanism with your own template, so that you can be even more productive when building your {shiny} app. Module template functions do not aim at being called as is by users, but to be passed as an argument to the add_module() function.

Usage

module_template(name, path, export, ph_ui = " ", ph_server = " ", ...)

Arguments

Details

Module template functions are a way to define your own template function for module. A template function that can take the following arguments to be passed from add_module():

• name: the name of the module

• path: the path to the file in R/

• export: a TRUE/FALSE set by the export param of add_module()

If you want your function to ignore these parameters, set ... as the last argument of your function, then these will be ignored. See the examples section of this help.

Value

Used for side effect

See Also

add_module()

Examples

if (interactive()) {
  my_tmpl <- function(name, path, ...) {
    # Define a template that write to the
    # module file
    write(name, path)
  }
  golem::add_module(name = "custom", module_template = my_tmpl)

  my_other_tmpl <- function(name, path, ...) {
    # Copy and paste a file from somewhere
    file.copy(..., path)
  }
  golem::add_module(name = "custom", module_template = my_other_tmpl)
}

Package tools

Description

These are functions to help you navigate inside your project while developing

Usage

pkg_name(golem_wd = get_golem_wd(), path)

pkg_version(golem_wd = get_golem_wd(), path)

pkg_path(golem_wd = getwd())

Arguments

Value

The value of the entry in the DESCRIPTION file

Project Hook

Description

Project hooks allow to define a function run just after {golem} project creation.

Usage

project_hook(path, package_name, ...)

Arguments

Value

Used for side effects

Examples

if (interactive()) {
  my_proj <- function(...) {
    unlink("dev/", TRUE, TRUE)
  }
  create_golem("ici", project_template = my_proj)
}

Run the dev/run_dev.R file

Description

The default file="dev/run_dev.R" launches your {golem} app with a bunch of useful options. The file content can be customized and file-name and path changed as long as the argument combination of file and pkg are supplied correctly: the file-path is a relative path to a {golem}-package root pkg. An error is thrown if pkg/file cannot be found.

Usage

run_dev(
  file = "dev/run_dev.R",
  golem_wd = get_golem_wd(),
  save_all = TRUE,
  install_required_packages = TRUE,
  pkg
)

Arguments

Details

The function run_dev() is typically used to launch a shiny app by sourcing the content of an appropriate run_dev-file. Carefully read the content of dev/run_dev.R when creating your custom run_dev-file. It has already many useful settings including a switch between production/development, reloading the package in a clean R environment before running the app etc.

Value

pure side-effect function; returns invisibly

Sanity check for R files in the project

Description

This function is used check for any 'browser()“ or commented #TODO / #TOFIX / #BUG in the code

Usage

sanity_check(golem_wd = get_golem_wd(), pkg)

Arguments

Value

A DataFrame if any of the words has been found.

Set the golem working directory

Description

Set the golem_wd value (the working directory of the current golem package) inside the golem-config.yml file.

Usage

set_golem_wd(
  new_golem_wd = golem::pkg_path(),
  current_golem_wd = golem::pkg_path(),
  talkative = TRUE,
  golem_wd,
  pkg
)

Arguments

Value

Used for side-effects, and returns the golem_wd path invisibly.

Implement Agent Skills in a golem Project

Description

Implement Agent Skills in a golem Project

Usage

use_agent_implement(
  source = c("ask", "local", "remote"),
  agent_specs = c("ask", "claude", "agents", "both"),
  skills = NULL,
  main_md_files = c("ask", "yes", "no"),
  overwrite = c("ask", "overwrite", "skip", "abort"),
  golem_wd = get_golem_wd(),
  interactive = rlang_is_interactive()
)

Arguments

Value

A list of selected options and copied paths, invisibly.

See Also

use_skills(), use_agent_skills(), use_claude_skills(), use_skill()

Add Agent Skills to a golem Project

Description

Add Agent Skills to a golem Project

Usage

use_agent_skills(
  source = c("ask", "local", "remote"),
  skills = NULL,
  main_md_files = c("ask", "yes", "no"),
  overwrite = c("ask", "overwrite", "skip", "abort"),
  golem_wd = get_golem_wd(),
  interactive = rlang_is_interactive()
)

Arguments

Value

A list of selected options and copied paths, invisibly.

See Also

use_skills(), use_agent_implement(), use_claude_skills(), use_skill()

Add Claude Skills to a golem Project

Description

Add Claude Skills to a golem Project

Usage

use_claude_skills(
  source = c("ask", "local", "remote"),
  skills = NULL,
  main_md_files = c("ask", "yes", "no"),
  overwrite = c("ask", "overwrite", "skip", "abort"),
  golem_wd = get_golem_wd(),
  interactive = rlang_is_interactive()
)

Arguments

Value

A list of selected options and copied paths, invisibly.

See Also

use_skills(), use_agent_implement(), use_agent_skills(), use_skill()

Use Files

Description

These functions download files from external sources and put them inside the inst/app/www directory. The use_internal_ functions will copy internal files, while use_external_ will try to download them from a remote location.

Usage

use_external_js_file(
  url,
  name = NULL,
  golem_wd = get_golem_wd(),
  dir = "inst/app/www",
  open = FALSE,
  dir_create,
  pkg,
  replace = FALSE
)

use_external_css_file(
  url,
  name = NULL,
  golem_wd = get_golem_wd(),
  dir = "inst/app/www",
  open = FALSE,
  dir_create,
  pkg,
  replace = FALSE
)

use_external_html_template(
  url,
  name = "template.html",
  golem_wd = get_golem_wd(),
  dir = "inst/app/www",
  open = FALSE,
  dir_create,
  extract = c("ask", "yes", "no"),
  delete_zip = c("ask", "yes", "no"),
  replace = FALSE
)

use_external_file(
  url,
  name = NULL,
  golem_wd = get_golem_wd(),
  dir = "inst/app/www",
  open = FALSE,
  dir_create,
  pkg,
  replace = FALSE
)

use_bundled_html(
  url,
  name = NULL,
  golem_wd = get_golem_wd(),
  dir = "inst/app/www",
  open = FALSE,
  extract = c("ask", "yes", "no"),
  delete_zip = c("ask", "yes", "no"),
  replace = FALSE
)

use_internal_js_file(
  path,
  name = NULL,
  golem_wd = get_golem_wd(),
  dir = "inst/app/www",
  open = FALSE,
  dir_create,
  pkg
)

use_internal_css_file(
  path,
  name = NULL,
  golem_wd = get_golem_wd(),
  dir = "inst/app/www",
  open = FALSE,
  dir_create,
  pkg
)

use_internal_html_template(
  path,
  name = "template.html",
  golem_wd = get_golem_wd(),
  dir = "inst/app/www",
  open = FALSE,
  dir_create,
  pkg
)

use_internal_file(
  path,
  name = NULL,
  golem_wd = get_golem_wd(),
  dir = "inst/app/www",
  open = FALSE,
  dir_create,
  pkg
)

Arguments

Value

The path to the file, invisibly.

Note

See ?htmltools::htmlTemplate and ⁠https://shiny.posit.co/r/articles/build/templates/⁠ for more information about htmlTemplate.

Add a favicon to your shinyapp

Description

This function adds the favicon from ico to your shiny app.

Usage

use_favicon(path, golem_wd = get_golem_wd(), method = "curl", pkg)

remove_favicon(path = "inst/app/www/favicon.ico")

favicon(
  ico = "favicon",
  rel = "shortcut icon",
  resources_path = "www",
  ext = "ico"
)

Arguments

Value

Used for side-effects.

An HTML tag.

Examples

if (interactive()) {
  use_favicon()
  use_favicon(path = "path/to/your/favicon.ico")
}

Add a test file for a module

Description

Add a test file for in module, with the new testServer structure.

Usage

use_module_test(name, golem_wd = get_golem_wd(), open = TRUE, pkg)

Arguments

Value

Used for side effect. Returns the path invisibly.

Generate a README.Rmd

Description

Generate a README.Rmd

Usage

use_readme_rmd(
  open = rlang::is_interactive(),
  pkg_name = golem::get_golem_name(),
  overwrite = FALSE,
  golem_wd = golem::get_golem_wd(),
  pkg
)

Arguments

Value

pure side-effect function that generates template README.Rmd

Add recommended elements

Description

Add recommended elements

Usage

use_recommended_tests(
  golem_wd = get_golem_wd(),
  spellcheck = TRUE,
  vignettes = TRUE,
  lang = "en-US",
  error = FALSE,
  pkg
)

Arguments

Value

Used for side-effects.

Add a Single Skill to Installed Agent Specifications

Description

Add a Single Skill to Installed Agent Specifications

Usage

use_skill(
  name,
  source = NULL,
  overwrite = c("ask", "overwrite", "skip", "abort"),
  golem_wd = get_golem_wd(),
  interactive = rlang_is_interactive()
)

Arguments

Value

A list of selected options and copied paths, invisibly.

See Also

use_skills(), use_agent_implement(), use_agent_skills(), use_claude_skills()

Add Skills to a golem Project

Description

Add Skills to a golem Project

Usage

use_skills(
  source = c("ask", "local", "remote"),
  agent_specs = c("ask", "claude", "agents", "both"),
  skills = NULL,
  main_md_files = c("ask", "yes", "no"),
  overwrite = c("ask", "overwrite", "skip", "abort"),
  golem_wd = get_golem_wd(),
  interactive = rlang_is_interactive()
)

Arguments

Value

A list of selected options and copied paths, invisibly.

Variants

• use_skills() is the main entry point — pick the agent target via agent_specs ("claude", "agents", or "both").

• use_agent_skills() and use_claude_skills() are convenience wrappers for use_skills(agent_specs = "agents") and use_skills(agent_specs = "claude").

• use_skill() adds a single skill to an already-installed agent target, without touching CLAUDE.md / AGENTS.md.

See Also

use_agent_implement(), use_agent_skills(), use_claude_skills(), use_skill()

Use the utils files

Description

use_utils_ui

Copies the golem_utils_ui.R to the R folder.

use_utils_server

Copies the golem_utils_server.R to the R folder.

Usage

use_utils_ui(golem_wd = get_golem_wd(), with_test = FALSE, pkg)

use_utils_test_ui(golem_wd = get_golem_wd(), pkg)

use_utils_server(golem_wd = get_golem_wd(), with_test = FALSE, pkg)

use_utils_test_ui(golem_wd = get_golem_wd(), pkg)

use_utils_test_server(golem_wd = get_golem_wd(), pkg)

Arguments

Value

Used for side-effects.

Add Golem options to a Shiny App

Description

You'll probably never have to write this function as it is included in the golem template created on launch.

Usage

with_golem_options(
  app,
  golem_opts,
  maintenance_page = golem::maintenance_page,
  print = FALSE
)

Arguments

Value

a shiny.appObj object