Learn R Programming

⚠️There's a newer version (0.5.1) of this package.Take me there.

{golem}

{golem} is an opinionated framework for building production-grade shiny applications.

About

You’re reading the doc about version : 0.4.1

This README has been compiled on the

Sys.time()
#> [1] "2023-06-05 16:57:28 CEST"

Here are the test & coverage results :

devtools::check(quiet = TRUE)
#> ℹ Loading golem
#> ── R CMD check results ──────────────────────────────────────── golem 0.4.1 ────
#> Duration: 1m 18.7s
#> 
#> 0 errors ✔ | 0 warnings ✔ | 0 notes ✔
covr::package_coverage()
#> golem Coverage: 58.99%
#> R/add_dockerfiles_renv.R: 0.00%
#> R/add_dockerfiles.R: 0.00%
#> R/addins.R: 0.00%
#> R/bootstrap_attachment.R: 0.00%
#> R/bootstrap_dockerfiler.R: 0.00%
#> R/bootstrap_rstudio_api.R: 0.00%
#> R/enable_roxygenize.R: 0.00%
#> R/get_sysreqs.R: 0.00%
#> R/gobals.R: 0.00%
#> R/run_dev.R: 0.00%
#> R/sanity_check.R: 0.00%
#> R/use_files.R: 0.00%
#> R/with_opt.R: 22.58%
#> R/config.R: 28.21%
#> R/test_helpers.R: 30.26%
#> R/js.R: 43.75%
#> R/reload.R: 45.36%
#> R/utils.R: 54.14%
#> R/use_recommended.R: 54.55%
#> R/bootstrap_desc.R: 55.56%
#> R/install_dev_deps.R: 57.14%
#> R/bootstrap_usethis.R: 76.56%
#> R/boostrap_fs.R: 77.78%
#> R/modules_fn.R: 80.00%
#> R/use_utils.R: 83.33%
#> R/use_favicon.R: 85.56%
#> R/desc.R: 86.25%
#> R/add_resource_path.R: 88.89%
#> R/create_golem.R: 89.47%
#> R/make_dev.R: 90.00%
#> R/add_r_files.R: 91.67%
#> R/add_files.R: 92.31%
#> R/add_rstudio_files.R: 93.10%
#> R/golem-yaml-get.R: 93.18%
#> R/boostrap_cli.R: 100.00%
#> R/boostrap_crayon.R: 100.00%
#> R/bootstrap_pkgload.R: 100.00%
#> R/bootstrap_roxygen2.R: 100.00%
#> R/browser_button.R: 100.00%
#> R/bundle_resources.R: 100.00%
#> R/disable_autoload.R: 100.00%
#> R/golem-yaml-set.R: 100.00%
#> R/golem-yaml-utils.R: 100.00%
#> R/is_running.R: 100.00%
#> R/pkg_tools.R: 100.00%
#> R/set_golem_options.R: 100.00%
#> R/templates.R: 100.00%

Tool series

This package is part of a series of tools for Shiny, which includes:

Resources

The Book :

Blog posts :

Building Big Shiny Apps

Make a Fitness App from scratch

Slide decks

Video

Copy Link

Version

Install

install.packages('golem')

Monthly Downloads

9,922

Version

0.4.1

License

MIT + file LICENSE

Issues

Pull Requests

Stars

Forks

Maintainer

Colin FAY

Last Published

August 27th, 2024

Functions in golem (0.4.1)

bundle_resources

Automatically serve golem external resources
create_golem

Create a package for a Shiny App using {golem}
amend_golem_config

Amend golem config file
fill_desc

Fill your description
browser_button

Insert an hidden browser button
golem

A package for building Shiny App
use_favicon

Add a favicon to your shinyapp
get_current_config

Get the path to the current config File
get_golem_options

Get all or one golem options
get_sysreqs

Get system requirements (Deprecated)
activate_js

Interact with JavaScript built-in Functions
make_dev

Make a function dependent to dev mode
maintenance_page

maintenance_page
add_dockerfile

Create a Dockerfile for your App
document_and_reload

Document and reload your package
pkg_name

Package tools
module_template

Golem Module Template Function
install_dev_deps

Install golem dev dependencies
get_golem_wd

{golem} options
add_fct

Add fct_ and utils_ files
use_module_test

Add a test file for a module
use_recommended_deps

Add recommended elements
add_rstudioconnect_file

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

Functions already made dev dependent
is_running

Is the running app a golem app?
run_dev

Run run_dev.R
js_handler_template

Golem's default custom templates
sanity_check

Sanity check for R files in the project
expect_shinytag

Test helpers
app_prod

Is the app in dev mode or prod mode?
project_hook

Project Hook
use_external_js_file

Use Files
use_utils_ui

Use the utils files
with_golem_options

Add Golem options to a Shiny App
disable_autoload

Disabling Shiny Autoload of R Scripts
add_module

Create a module
detach_all_attached

Detach all attached package
addins

{golem} addins
add_resource_path

Add resource path
add_js_file

Create Files