{"id":14068850,"url":"https://github.com/ColinFay/golemexample","last_synced_at":"2025-07-30T04:32:29.810Z","repository":{"id":134241696,"uuid":"194681204","full_name":"ColinFay/golemexample","owner":"ColinFay","description":"An example app for illustrating golem features","archived":false,"fork":false,"pushed_at":"2019-10-02T18:23:03.000Z","size":101,"stargazers_count":25,"open_issues_count":2,"forks_count":9,"subscribers_count":3,"default_branch":"master","last_synced_at":"2024-08-13T07:15:23.093Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"R","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ColinFay.png","metadata":{"files":{"readme":"README.Rmd","changelog":"NEWS.md","contributing":null,"funding":null,"license":null,"code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2019-07-01T13:46:43.000Z","updated_at":"2023-10-03T21:07:59.000Z","dependencies_parsed_at":null,"dependency_job_id":"e20b7ffc-eb67-4175-a3fa-1e36ad54c031","html_url":"https://github.com/ColinFay/golemexample","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/ColinFay/golemexample","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ColinFay%2Fgolemexample","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ColinFay%2Fgolemexample/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ColinFay%2Fgolemexample/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ColinFay%2Fgolemexample/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ColinFay","download_url":"https://codeload.github.com/ColinFay/golemexample/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ColinFay%2Fgolemexample/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":267809562,"owners_count":24147495,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-07-30T02:00:09.044Z","response_time":70,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-08-13T07:06:26.550Z","updated_at":"2025-07-30T04:32:29.330Z","avatar_url":"https://github.com/ColinFay.png","language":"R","readme":"---\noutput: github_document\n---\n\n\u003c!-- README.md is generated from README.Rmd. Please edit that file --\u003e\n\n```{r, include = FALSE}\nknitr::opts_chunk$set(\n  collapse = TRUE,\n  comment = \"#\u003e\",\n  fig.path = \"man/figures/README-\",\n  out.width = \"100%\"\n)\n```\n# golemexample\n\n\u003c!-- badges: start --\u003e\n[![Lifecycle: experimental](https://img.shields.io/badge/lifecycle-experimental-orange.svg)](https://www.tidyverse.org/lifecycle/#experimental)\n\u003c!-- badges: end --\u003e\n\nThe goal of golemexample is to provide some examples for the inner configuration of a `{golem}` app.\n\n## Share value across modules \n\n+ Add a top level reactiveValue \u003chttps://github.com/ColinFay/golemexample/blob/master/R/app_server.R#L6\u003e\n\n+ Add a nested level inside modules \u003chttps://github.com/ColinFay/golemexample/blob/master/R/mod_my_other_module.R#L35\u003e\n\n+ Share this across modules \u003chttps://github.com/ColinFay/golemexample/blob/master/R/mod_my_third_module.R#L33\u003e\n\n## Change Shiny Options\n\n\u003chttps://github.com/ColinFay/golemexample/blob/master/R/run_app.R#L14\u003e\n\n## Adding external files \n\n### CSS\n\n+ Added with `dev/02_dev.R#29` \u003chttps://github.com/ColinFay/golemexample/blob/master/dev/02_dev.R#L29\u003e\n\n+ Personnalized in `inst/app/www/custom.css` \u003chttps://github.com/ColinFay/golemexample/tree/master/inst/app/www/custom.css\u003e\n\n+ Linked to the app at `R/app_ui.R#27` \u003chttps://github.com/ColinFay/golemexample/blob/master/R/app_ui.R#L27\u003e\n\n### JS \n\n#### Classic\n\n__A simple JS can be used from UI.__\n\n+ Added with `dev/02_dev.R#27` \u003chttps://github.com/ColinFay/golemexample/blob/master/dev/02_dev.R#L27\u003e\n\n+ Personnalized in `inst/app/www/alertme.js` \u003chttps://github.com/ColinFay/golemexample/blob/master/inst/app/www/alertme.js\u003e\n\n+ Linked to the app at `R/app_ui.R#28` \u003chttps://github.com/ColinFay/golemexample/blob/master/R/app_ui.R#L28\u003e\n\n+ Called with `tags$button(\"Alert!\", onclick = \"alertme();\")` at `R/mod_my_first_module.R#33` \u003chttps://github.com/ColinFay/golemexample/blob/master/R/mod_my_first_module.R#L33\u003e\n\n#### Handlers\n\n__A handler JS can be used from server side with `golem::invoke_js()`.__\n\n+ Added with `dev/02_dev.R#28` \u003chttps://github.com/ColinFay/golemexample/blob/master/dev/02_dev.R#L28\u003e\n\n+ Personnalized in `inst/app/www/handler.js` \u003chttps://github.com/ColinFay/golemexample/tree/master/inst/app/www/handler.js\u003e\n\n+ Linked to the app at `R/app_ui.R#29` \u003chttps://github.com/ColinFay/golemexample/blob/master/R/app_ui.R#L29\u003e\n\n+ Called with `golem::invoke_js(\"alertarg\", \"12\")` at `R/mod_my_first_module.R#58` \u003chttps://github.com/ColinFay/golemexample/blob/master/R/mod_my_first_module.R#L58\u003e\n\n### Image\n\n+ Downloaded at `inst/app/www/guit.jpg` \u003chttps://github.com/ColinFay/golemexample/blob/master/inst/app/www/guit.jpg\u003e\n\n+ Linked with `tags$img(src = \"www/guit.jpg\")` at `R/mod_my_first_module.R#23` \u003chttps://github.com/ColinFay/golemexample/blob/master/R/mod_my_first_module.R#L23\u003e\n\n## Passing arguments to `run_app`\n\n+ `run_app` \u003chttps://github.com/ColinFay/golemexample/blob/master/R/run_app.R#L6\u003e\n\n+ Read in UI at `R/app_ui.R#8` \u003chttps://github.com/ColinFay/golemexample/blob/master/R/app_ui.R#L8\u003e\n\n+ Read in server at `R/app_server.R#5` \u003chttps://github.com/ColinFay/golemexample/blob/master/R/app_server.R#L5\u003e\n\n## Using datasets inside your app \n\n+ Register your dataset as a package data \n\u003chttps://github.com/ColinFay/golemexample/blob/master/data-raw/dataset.R#L6\u003e which is turned into \u003chttps://github.com/ColinFay/golemexample/blob/master/data/plop.rda\u003e\n\n+ Use your data object wherever you need it (in your UI or server)\n\n## Using shiny::includeXXX\n\n+ Add elements in `inst/app/www` \u003chttps://github.com/ColinFay/golemexample/blob/master/inst/app/www/plop.md\u003e\n\n+ Use `system.file(\"app/www/plop.md\", package = \"golemexample\")` \u003chttps://github.com/ColinFay/golemexample/blob/master/R/mod_my_fifth_module.R#L19\u003e\n\n\u003chr\u003e\n\nPlease note that the 'golemexample' project is released with a\n[Contributor Code of Conduct](CODE_OF_CONDUCT.md).\nBy contributing to this project, you agree to abide by its terms.\n","funding_links":[],"categories":["R"],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FColinFay%2Fgolemexample","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FColinFay%2Fgolemexample","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FColinFay%2Fgolemexample/lists"}