Skip to contents

All functions

add_js_file() add_js_handler() add_js_input_binding() add_js_output_binding() add_css_file() add_sass_file() add_empty_file() add_html_template() add_partial_html_template() add_ui_server_files()
Create Files
add_module()
Create a module
add_resource_path()
Add resource path
insert_ns() go_to_start() go_to_dev() go_to_deploy() go_to_run_dev() go_to_app_ui() go_to_app_server() go_to_run_app()
golem addins
amend_golem_config()
Amend golem config file
browser_button()
Insert an hidden browser button
bundle_resources()
Automatically serve golem external resources
create_golem()
Create a package for a Shiny App using golem
detach_all_attached()
Detach all attached package
disable_autoload()
Disabling Shiny Autoload of R Scripts
add_dockerfile() add_dockerfile_shinyproxy() add_dockerfile_heroku() add_dockerfile_with_renv() add_dockerfile_with_renv_shinyproxy() add_dockerfile_with_renv_heroku()
Create a Dockerfile for your App
document_and_reload()
Document and reload your package
use_favicon() remove_favicon() favicon()
Add a favicon to your shinyapp
add_fct() add_utils() add_r6()
Add fct_ and utils_ files
fill_desc()
Fill your DESCRIPTION file
get_current_config()
Return path to the golem config-file
get_golem_options()
Get all or one golem options
get_sysreqs()
Get system requirements (Deprecated)
golem-package golem
A package for building Shiny App
activate_js() invoke_js()
Interact with JavaScript built-in Functions
get_golem_wd() get_golem_name() get_golem_version() set_golem_wd() set_golem_name() set_golem_version() set_golem_options()
golem options
golem_welcome_page()
Welcome Page
install_dev_deps()
Install golem dev dependencies
is_golem()
Is the directory a golem-based app?
is_running()
Is the running app a golem app?
cat_dev() print_dev() message_dev() warning_dev() browser_dev()
Functions already made dev dependent
maintenance_page()
maintenance_page
make_dev()
Make a function dependent to dev mode
module_template()
Golem Module Template Function
pkg_name() pkg_version() pkg_path()
Package tools
app_prod() app_dev()
Is the app in dev mode or prod mode?
project_hook()
Project Hook
add_positconnect_file() add_rstudioconnect_file() add_shinyappsio_file() add_shinyserver_file() add_rscignore_file()
Add an app.R at the root of your package to deploy on RStudio Connect
run_dev()
Run the dev/run_dev.R file
sanity_check()
Sanity check for R files in the project
js_handler_template() js_template() css_template() sass_template() empty_template()
Golem's default custom templates
expect_shinytag() expect_shinytaglist() expect_html_equal() expect_running()
Test helpers
use_external_js_file() use_external_css_file() use_external_html_template() use_external_file() use_internal_js_file() use_internal_css_file() use_internal_html_template() use_internal_file()
Use Files
use_module_test()
Add a test file for a module
use_readme_rmd()
Generate a README.Rmd
use_recommended_deps() use_recommended_tests()
Add recommended elements
use_utils_ui() use_utils_test_ui() use_utils_server() use_utils_test_server()
Use the utils files
with_golem_options()
Add Golem options to a Shiny App