# A Framework for Robust Shiny Applications

## Documentation for package ‘golem’ version 1.0.0

- DESCRIPTION file
- User guides, package vignettes and other documentation
- Package NEWS
- Package README

## Help Pages

A B C D E F G I J M P R S U W

golem-package | A package for building Shiny App

## -- A --

activate_js | Interact with JavaScript built-in Functions
addins | '{golem}' addins
add_css_file | Create Files
add_dockerfile | Create a Dockerfile for your App
add_dockerfile_heroku | Create a Dockerfile for your App
add_dockerfile_shinyproxy | Create a Dockerfile for your App
add_dockerfile_with_renv | Create a Dockerfile for your App
add_dockerfile_with_renv_heroku | Create a Dockerfile for your App
add_dockerfile_with_renv_shinyproxy | Create a Dockerfile for your App
add_empty_file | Create Files
add_fct | Add fct_ and utils_ files
add_github_action | Add deployment CI for GitHub Actions
add_gitlab_ci | Add deployment CI for GitLab
add_html_template | Create Files
add_js_file | Create Files
add_js_handler | Create Files
add_js_input_binding | Create Files
add_js_output_binding | Create Files
add_module | Create a module
add_partial_html_template | Create Files
add_positconnect_file | Add an 'app.R' at the root of your package to deploy on RStudio Connect
add_r6 | Add fct_ and utils_ files
add_rconnect_file | Add an 'app.R' at the root of your package to deploy on RStudio Connect
add_resource_path | Add resource path
add_rscignore_file | Add an 'app.R' at the root of your package to deploy on RStudio Connect
add_sass_file | Create Files
add_shinyappsio_file | Add an 'app.R' at the root of your package to deploy on RStudio Connect
add_shinyserver_file | Add an 'app.R' at the root of your package to deploy on RStudio Connect
add_ui_server_files | Create Files
add_utils | Add fct_ and utils_ files
amend_golem_config | Amend golem config file
app_dev | Is the app in dev mode or prod mode?
app_prod | Is the app in dev mode or prod mode?

## -- B --

browser_button | Insert an hidden browser button
browser_dev | Functions already made dev dependent
bundle_resources | Automatically serve golem external resources

## -- C --

cat_dev | Functions already made dev dependent
create_golem | Create a package for a Shiny App using '{golem}'
css_template | Golem's default custom templates

## -- D --

detach_all_attached | Detach all attached package
disable_autoload | Disabling Shiny Autoload of R Scripts
document_and_reload | Document and reload your package

## -- E --

empty_template | Golem's default custom templates
expect_html_equal | Test helpers
expect_running | Test helpers
expect_shinytag | Test helpers
expect_shinytaglist | Test helpers

## -- F --

favicon | Add a favicon to your shinyapp
fct_template | Golem Function Template
fill_desc | Fill your 'DESCRIPTION' file

## -- G --

get_current_config | Return path to the '{golem}' config-file
get_golem_name | '{golem}' options
get_golem_options | Get all or one golem options
get_golem_version | '{golem}' options
get_golem_wd | '{golem}' options
golem | A package for building Shiny App
golem_welcome_page | Welcome Page
go_to_app_server | '{golem}' addins
go_to_app_ui | '{golem}' addins
go_to_deploy | '{golem}' addins
go_to_dev | '{golem}' addins
go_to_run_app | '{golem}' addins
go_to_run_dev | '{golem}' addins
go_to_start | '{golem}' addins

## -- I --

insert_ns | '{golem}' addins
install_dev_deps | Install '{golem}' dev dependencies
invoke_js | Interact with JavaScript built-in Functions
is_golem | Is the directory a golem-based app?
is_running | Is the running app a golem app?

## -- J --

js_handler_template | Golem's default custom templates
js_template | Golem's default custom templates

## -- M --

maintenance_page | maintenance_page
make_dev | Make a function dependent to dev mode
message_dev | Functions already made dev dependent
module_template | Golem Module Template Function

## -- P --

pkg_name | Package tools
pkg_path | Package tools
pkg_version | Package tools
print_dev | Functions already made dev dependent
project_hook | Project Hook

## -- R --

remove_favicon | Add a favicon to your shinyapp
run_dev | Run the 'dev/run_dev.R' file

## -- S --

sanity_check | Sanity check for R files in the project
sass_template | Golem's default custom templates
set_golem_name | '{golem}' options
set_golem_options | '{golem}' options
set_golem_version | '{golem}' options
set_golem_wd | Set the golem working directory

## -- U --

use_agent_skills | Add Agent Skills to a golem Project
use_bundled_html | Use Files
use_claude_skills | Add Claude Skills to a golem Project
use_external_css_file | Use Files
use_external_file | Use Files
use_external_html_template | Use Files
use_external_js_file | Use Files
use_favicon | Add a favicon to your shinyapp
use_internal_css_file | Use Files
use_internal_file | Use Files
use_internal_html_template | Use Files
use_internal_js_file | Use Files
use_module_test | Add a test file for a module
use_readme_rmd | Generate a README.Rmd
use_recommended_tests | Add recommended elements
use_skill | Add a Single Skill to Installed Agent Specifications
use_skills | Add Skills to a golem Project
use_utils_server | Use the utils files
use_utils_test_server | Use the utils files
use_utils_test_ui | Use the utils files
use_utils_ui | Use the utils files

## -- W --

warning_dev | Functions already made dev dependent
with_golem_options | Add Golem options to a Shiny App