Package: golem 0.5.1

Colin Fay

golem: A Framework for Robust Shiny Applications

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.

Authors:Colin Fay [cre, aut], Vincent Guyader [aut], 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]

golem_0.5.1.tar.gz
golem_0.5.1.zip(r-4.5)golem_0.5.1.zip(r-4.4)golem_0.5.1.zip(r-4.3)
golem_0.5.1.tgz(r-4.4-any)golem_0.5.1.tgz(r-4.3-any)
golem_0.5.1.tar.gz(r-4.5-noble)golem_0.5.1.tar.gz(r-4.4-noble)
golem_0.5.1.tgz(r-4.4-emscripten)golem_0.5.1.tgz(r-4.3-emscripten)
golem.pdf |golem.html
golem/json (API)
NEWS

# Install 'golem' in R:
install.packages('golem', repos = c('https://thinkr-open.r-universe.dev', 'https://cloud.r-project.org'))

Peer review:

Bug tracker:https://github.com/thinkr-open/golem/issues

On CRAN:

golemversehacktoberfestshinyshiny-appsshiny-rshinyapps

95 exports 908 stars 14.29 score 35 dependencies 57 dependents 2 mentions 150 scripts 9.8k downloads

Last updated 2 months agofrom:629179665d. Checks:OK: 7. Indexed: yes.

TargetResultDate
Doc / VignettesOKSep 26 2024
R-4.5-winOKSep 26 2024
R-4.5-linuxOKSep 26 2024
R-4.4-winOKSep 26 2024
R-4.4-macOKSep 26 2024
R-4.3-winOKSep 26 2024
R-4.3-macOKSep 26 2024

Exports:activate_jsadd_css_fileadd_dockerfileadd_dockerfile_herokuadd_dockerfile_shinyproxyadd_dockerfile_with_renvadd_dockerfile_with_renv_herokuadd_dockerfile_with_renv_shinyproxyadd_empty_fileadd_fctadd_html_templateadd_js_fileadd_js_handleradd_js_input_bindingadd_js_output_bindingadd_moduleadd_partial_html_templateadd_positconnect_fileadd_r6add_resource_pathadd_rscignore_fileadd_rstudioconnect_fileadd_sass_fileadd_shinyappsio_fileadd_shinyserver_fileadd_ui_server_filesadd_utilsamend_golem_configapp_devapp_prodbrowser_buttonbrowser_devbundle_resourcescat_devcreate_golemcss_templatedetach_all_attacheddisable_autoloaddocument_and_reloadempty_templateexpect_html_equalexpect_runningexpect_shinytagexpect_shinytaglistfaviconfill_descget_current_configget_golem_nameget_golem_optionsget_golem_versionget_golem_wdget_sysreqsgolem_welcome_pageinstall_dev_depsinvoke_jsis_golemis_runningjs_handler_templatejs_templatemaintenance_pagemake_devmessage_devmodule_templatepkg_namepkg_pathpkg_versionprint_devproject_hookremove_faviconrun_devsanity_checksass_templateset_golem_nameset_golem_optionsset_golem_versionset_golem_wduse_external_css_fileuse_external_fileuse_external_html_templateuse_external_js_fileuse_faviconuse_internal_css_fileuse_internal_fileuse_internal_html_templateuse_internal_js_fileuse_module_testuse_readme_rmduse_recommended_depsuse_recommended_testsuse_utils_serveruse_utils_test_serveruse_utils_test_uiuse_utils_uiwarning_devwith_golem_options

Dependencies:attemptbase64encbslibcachemclicommonmarkconfigcrayondigestfastmapfontawesomefsglueherehtmltoolshttpuvjquerylibjsonlitelaterlifecyclemagrittrmemoisemimepromisesR6rappdirsRcpprlangrprojrootsassshinysourcetoolswithrxtableyaml

a_start

Rendered froma_start.Rmdusingknitr::rmarkdownon Sep 26 2024.

Last update: 2024-08-16
Started: 2019-04-08

b_dev

Rendered fromb_dev.Rmdusingknitr::rmarkdownon Sep 26 2024.

Last update: 2024-08-16
Started: 2019-04-08

c_deploy

Rendered fromc_deploy.Rmdusingknitr::rmarkdownon Sep 26 2024.

Last update: 2024-08-16
Started: 2019-04-08

e_config

Rendered frome_config.Rmdusingknitr::rmarkdownon Sep 26 2024.

Last update: 2023-03-10
Started: 2020-03-04

d_js

Rendered fromd_js.Rmdusingknitr::rmarkdownon Sep 26 2024.

Last update: 2022-10-12
Started: 2019-04-08

e_golem_cheatsheet

Rendered fromz_golem_cheatsheet.Rmdusingknitr::rmarkdownon Sep 26 2024.

Last update: 2022-10-12
Started: 2020-03-04

f_extending_golem

Rendered fromf_extending_golem.Rmdusingknitr::rmarkdownon Sep 26 2024.

Last update: 2024-08-16
Started: 2020-09-25

Readme and manuals

Help Manual

Help pageTopics
Interact with JavaScript built-in Functionsactivate_js invoke_js
Create a Dockerfile for your Appadd_dockerfile add_dockerfile_heroku add_dockerfile_shinyproxy add_dockerfile_with_renv add_dockerfile_with_renv_heroku add_dockerfile_with_renv_shinyproxy
Add fct_ and utils_ filesadd_fct add_r6 add_utils
Create Filesadd_css_file add_empty_file add_html_template add_js_file add_js_handler add_js_input_binding add_js_output_binding add_partial_html_template add_sass_file add_ui_server_files
Create a moduleadd_module
Add an 'app.R' at the root of your package to deploy on RStudio Connectadd_positconnect_file add_rconnect_file add_rscignore_file add_rstudioconnect_file add_shinyappsio_file add_shinyserver_file
Add resource pathadd_resource_path
'{golem}' addinsaddins go_to_app_server go_to_app_ui go_to_deploy go_to_dev go_to_run_app go_to_run_dev go_to_start insert_ns
Amend golem config fileamend_golem_config
Is the app in dev mode or prod mode?app_dev app_prod
Insert an hidden browser buttonbrowser_button
Automatically serve golem external resourcesbundle_resources
Functions already made dev dependentbrowser_dev cat_dev message_dev print_dev warning_dev
Create a package for a Shiny App using '{golem}'create_golem
Detach all attached packagedetach_all_attached
Disabling Shiny Autoload of R Scriptsdisable_autoload
Document and reload your packagedocument_and_reload
Test helpersexpect_html_equal expect_running expect_shinytag expect_shinytaglist
Fill your 'DESCRIPTION' filefill_desc
Return path to the '{golem}' config-fileget_current_config
Get all or one golem optionsget_golem_options
'{golem}' optionsget_golem_name get_golem_version get_golem_wd set_golem_name set_golem_options set_golem_version set_golem_wd
Get system requirements (Deprecated)get_sysreqs
A package for building Shiny Appgolem-package golem
Welcome Pagegolem_welcome_page
Install '{golem}' dev dependenciesinstall_dev_deps
Is the directory a golem-based app?is_golem
Is the running app a golem app?is_running
Golem's default custom templatescss_template empty_template js_handler_template js_template sass_template
maintenance_pagemaintenance_page
Make a function dependent to dev modemake_dev
Golem Module Template Functionmodule_template
Package toolspkg_name pkg_path pkg_version
Project Hookproject_hook
Run the 'dev/run_dev.R' filerun_dev
Sanity check for R files in the projectsanity_check
Use Filesuse_external_css_file use_external_file use_external_html_template use_external_js_file use_internal_css_file use_internal_file use_internal_html_template use_internal_js_file
Add a favicon to your shinyappfavicon remove_favicon use_favicon
Add a test file for a moduleuse_module_test
Generate a README.Rmduse_readme_rmd
Add recommended elementsuse_recommended_deps use_recommended_tests
Use the utils filesuse_utils_server use_utils_test_server use_utils_test_ui use_utils_ui
Add Golem options to a Shiny Appwith_golem_options