From ebcfe136db2ad4b0e4f8d15314508376738f6802 Mon Sep 17 00:00:00 2001 From: vincent guyader Date: Tue, 8 Aug 2023 16:33:21 +0200 Subject: [PATCH] Dev 1026 (#1081) * Fix 1026 (#1064) * docs: link to golemverse for external resources The "Example Apps" section on the golemverse page is missing, so I kept it there for as a level two header (in case one wants to copy it to the golemvsere page). * docs: move sections with relevant content for the user to the top I. user preferences in terms of priority (more or less ...) probably 1. Installation 2. New project creation 3. Every day workflow 4. Additional resources 5. Meta info such as about (golem version/code coverage), CoC, how to contribute etc. II. developer preference in terms of priority (more or less ...) probably 1. Meta info in the "About" section golem version/code coverage 2. the rest from above Though I'd prefer the current ordering myself it might be a wise choice to change it towards the user, but that's a matter of taste. Fix some typos and markdown styling. --------- Co-authored-by: vincent guyader * chore update README fix #1026 --------- Co-authored-by: Ilya Zarubin <36898027+ilyaZar@users.noreply.github.com> --- README.Rmd | 137 +++++++++++----------------- README.md | 257 ++++++++++++++++++++++------------------------------- 2 files changed, 158 insertions(+), 236 deletions(-) diff --git a/README.Rmd b/README.Rmd index 8e7062d9..65253ad5 100644 --- a/README.Rmd +++ b/README.Rmd @@ -25,81 +25,71 @@ knitr::opts_chunk$set( `{golem}` is an opinionated framework for building production-grade shiny applications. -## About - -You're reading the doc about version : `r pkgload::pkg_version()` +## Installation -This README has been compiled on the +- You can install the stable version from CRAN with: -```{r} -Sys.time() +``` r +install.packages("golem") ``` -Here are the test & coverage results : +- You can install the development version from [GitHub](https://github.com/Thinkr-open/golem) with: -```{r} -devtools::check(quiet = TRUE) +``` r +# install.packages("remotes") +remotes::install_github("Thinkr-open/golem") # very close to CRAN version +# remotes::install_github("Thinkr-open/golem@dev") # if you like to play ``` -```{r echo = FALSE} -unloadNamespace("golem") -``` +## Resources -```{r} -covr::package_coverage() -``` +The `{golem}` package is part of the [`{golemverse}`](https://golemverse.org/), a series of tools for Shiny. +A list of various `{golem}` related resources (tutorials, video, blog post,...) can be found [here](https://golemverse.org/resources/). -## Tool series -This package is part of a series of tools for Shiny, which includes: +## Launch the project -- `{golem}` - -- `{shinipsum}` - -- `{fakir}` - -- `{gemstones}` - +Create a new package with the project template: -## Resources +```{r, echo=FALSE, out.width="80%", eval=TRUE} +knitr::include_graphics("https://raw.githubusercontent.com/ThinkR-open/golem/master/inst/img/golemtemplate.png") +``` -### The Book : +## Step by step guide -- +See full documentation in the `{pkgdown}` website: -- [paper version of the book “Engineering Production-Grade Shiny Apps”](https://www.routledge.com/Engineering-Production-Grade-Shiny-Apps/Fay-Rochette-Guyader-Girard/p/book/9780367466022) +[CRAN] -### Blog posts : +[dev] -*Building Big Shiny Apps* +After project creation, you'll land on `dev/01_start.R`. There are also `dev/02_dev.R` and `dev/03_deploy.R` -- Part 1: -- Part 2: +These files are used to keep a track of all the steps you'll be following while building your app. -[*Make a Fitness App from scratch*](https://towardsdatascience.com/production-grade-r-shiny-with-golem-prototyping-51b03f37c2a9) +### Step 1 : Getting Started -### Slide decks +Read [the Getting Started](https://thinkr-open.github.io/golem/articles/a_start.html) Vignette for a detailed walkthrough. -- useR! 2019 : [A Framework for Building Robust & Production Ready Shiny Apps](https://github.com/VincentGuyader/user2019/raw/master/golem_Vincent_Guyader_USER!2019.pdf) -- ThinkR x RStudio Roadshow,Paris : [Production-grade Shiny Apps with {golem}](https://speakerdeck.com/colinfay/production-grade-shiny-apps-with-golem) -- rstudio::conf(2020) : [Production-grade Shiny Apps with golem](https://speakerdeck.com/colinfay/rstudio-conf-2020-production-grade-shiny-apps-with-golem) -- barcelonar (2019-12-03) : [Engineering Production-Grade Shiny Apps with -{golem}](https://www.barcelonar.org/presentations/BarcelonaR_Building_Production_Grade_Shiny_Apps_with_golem.pdf) +### Step 2 : Day to Day Dev -### Video +Read [Day to Day Dev](https://thinkr-open.github.io/golem/articles/b_dev.html) Vignette for a detailed walkthrough. -- [{golem} and Effective Shiny Development Methods](https://www.youtube.com/watch?v=OU1-CkSVdTI) -- [Hands-on demonstration of {golem}](https://www.youtube.com/watch?v=3-p9XLvoJV0) -- useR! 2019 : [A Framework for Building Robust & Production Ready Shiny Apps](https://youtu.be/tCAan6smrjs) -- `r emo::flag("France")` [Introduction to {golem}](https://youtu.be/6qI4NzxlAFU) -- rstudio::conf(2020) : [Production-grade Shiny Apps with golem](https://posit.co/resources/videos/production-grade-shiny-apps-with-golem/) -- `r emo::flag("France")` Rencontres R 2021 : [ Conception d'applications Shiny avec {golem}](https://www.youtube.com/watch?v=0f5Me1PFGDs) -- `r emo::flag("France")` [ Déploiement d'une application {shiny} dans docker avec {renv} et {golem}](https://www.youtube.com/watch?v=diCG4t76k78) -- `r emo::flag("France")` Rencontres R 2023 : [ {golem} et {fusen}, construire des apps Shiny robustes et faciles à maintenir](https://www.youtube.com/watch?v=cYKsYBFIpX0) +### Step 3: deploy +Read [Deploying Apps with {golem}](https://thinkr-open.github.io/golem/articles/c_deploy.html) Vignette for a detailed walkthrough. -### Cheatsheet -- [{golem} cheatsheet](https://thinkr.fr/golem_cheatsheet_v0.1.pdf) +## Tool series -### Examples apps +This package is part of a series of tools for Shiny, which includes: + +- `{golem}` - +- `{shinipsum}` - +- `{fakir}` - +- `{gemstones}` - + +## Examples apps These are examples from the community. Please note that they may not necessarily be written in a canonical fashion and may have been written with different versions of `{golem}` or `{shiny}`. @@ -113,52 +103,29 @@ You can also find apps at: - - -## Installation - -- You can install the stable version from CRAN with: +## About -``` r -install.packages("golem") -``` +You're reading the doc about version: `r pkgload::pkg_version()` -- You can install the development version from [GitHub](https://github.com/Thinkr-open/golem) with: +This `README` has been compiled on the -``` r -# install.packages("remotes") -remotes::install_github("Thinkr-open/golem") +```{r} +Sys.time() ``` -## Launch the project - -Create a new package with the project template: +Here are the test & coverage results: -```{r, echo=FALSE, out.width="80%", eval=TRUE} -knitr::include_graphics("https://raw.githubusercontent.com/ThinkR-open/golem/master/inst/img/golemtemplate.png") +```{r} +devtools::check(quiet = TRUE) ``` -## Step by step guide - -See full documentation in the {pkgdown} website: - -[CRAN] - -[dev] - -After project creation, you'll land on `dev/01_start.R`. There are also `dev/02_dev.R` and `dev/03_deploy.R` - -These files are used to keep a track of all the steps you'll be following while building your app. - -### Step 1 : Getting Started - -Read [the Getting Started](https://thinkr-open.github.io/golem/articles/a_start.html) Vignette for a detailed walkthrough. - -### Step 2 : Day to Day Dev - -Read [Day to Day Dev](https://thinkr-open.github.io/golem/articles/b_dev.html) Vignette for a detailed walkthrough. - -### Step 3: deploy +```{r echo = FALSE} +unloadNamespace("golem") +``` -Read [Deploying Apps with {golem}](https://thinkr-open.github.io/golem/articles/c_deploy.html) Vignette for a detailed walkthrough. +```{r} +covr::package_coverage() +``` ## CoC diff --git a/README.md b/README.md index 01ccaa7a..c654d477 100644 --- a/README.md +++ b/README.md @@ -17,214 +17,169 @@ status](https://www.r-pkg.org/badges/version/golem)](https://cran.r-project.org/ `{golem}` is an opinionated framework for building production-grade shiny applications. +## Installation + +- You can install the stable version from CRAN with: + +``` r +install.packages("golem") +``` + +- You can install the development version from + [GitHub](https://github.com/Thinkr-open/golem) with: + +``` r +# install.packages("remotes") +remotes::install_github("Thinkr-open/golem") # very close to CRAN version +# remotes::install_github("Thinkr-open/golem@dev") # if you like to play +``` + +## Resources + +The `{golem}` package is part of the +[`{golemverse}`](https://golemverse.org/), a series of tools for Shiny. +A list of various `{golem}` related resources (tutorials, video, blog +post,…) can be found [here](https://golemverse.org/resources/). + +## Launch the project + +Create a new package with the project template: + + + +## Step by step guide + +See full documentation in the `{pkgdown}` website: + +\[CRAN\] + +\[dev\] + +After project creation, you’ll land on `dev/01_start.R`. There are also +`dev/02_dev.R` and `dev/03_deploy.R` + +These files are used to keep a track of all the steps you’ll be +following while building your app. + +### Step 1 : Getting Started + +Read [the Getting +Started](https://thinkr-open.github.io/golem/articles/a_start.html) +Vignette for a detailed walkthrough. + +### Step 2 : Day to Day Dev + +Read [Day to Day +Dev](https://thinkr-open.github.io/golem/articles/b_dev.html) Vignette +for a detailed walkthrough. + +### Step 3: deploy + +Read [Deploying Apps with +{golem}](https://thinkr-open.github.io/golem/articles/c_deploy.html) +Vignette for a detailed walkthrough. + +## Tool series + +This package is part of a series of tools for Shiny, which includes: + +- `{golem}` - +- `{shinipsum}` - +- `{fakir}` - +- `{gemstones}` - + +## Examples apps + +These are examples from the community. Please note that they may not +necessarily be written in a canonical fashion and may have been written +with different versions of `{golem}` or `{shiny}`. + +- +- +- +- + +You can also find apps at: + +- +- + ## About -You’re reading the doc about version : 0.4.12 +You’re reading the doc about version: 0.4.12 -This README has been compiled on the +This `README` has been compiled on the ``` r Sys.time() -#> [1] "2023-08-07 13:23:40 UTC" +#> [1] "2023-08-08 14:20:03 UTC" ``` -Here are the test & coverage results : +Here are the test & coverage results: ``` r devtools::check(quiet = TRUE) #> ℹ Loading golem #> ── R CMD check results ─────────────────────────────────────── golem 0.4.12 ──── -#> Duration: 1m 32.1s -#> +#> Duration: 2m 36.7s +#> #> 0 errors ✔ | 0 warnings ✔ | 0 notes ✔ ``` ``` r covr::package_coverage() -#> golem Coverage: 69.09% +#> golem Coverage: 75.69% #> R/addins.R: 0.00% #> R/bootstrap_rstudio_api.R: 0.00% #> R/enable_roxygenize.R: 0.00% #> R/get_sysreqs.R: 0.00% -#> R/globals.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/install_dev_deps.R: 57.14% #> R/bootstrap_attachment.R: 61.54% #> R/bootstrap_dockerfiler.R: 63.33% #> R/bootstrap_desc.R: 66.67% #> R/add_dockerfiles.R: 74.19% -#> R/boostrap_fs.R: 77.78% +#> R/bootstrap_usethis.R: 78.57% #> R/use_recommended.R: 78.79% -#> R/modules_fn.R: 80.00% +#> R/modules_fn.R: 79.00% +#> R/golem-yaml-set.R: 83.02% #> R/use_utils.R: 83.33% -#> R/desc.R: 86.25% +#> R/utils.R: 85.13% +#> R/add_rstudio_files.R: 88.52% #> 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.01% #> R/add_files.R: 92.31% -#> R/add_rstudio_files.R: 93.10% #> R/golem-yaml-get.R: 93.18% -#> R/add_dockerfiles_renv.R: 93.75% +#> R/add_dockerfiles_renv.R: 93.78% +#> R/desc.R: 96.67% #> R/use_favicon.R: 96.67% +#> R/use_readme.R: 97.14% #> R/boostrap_cli.R: 100.00% #> R/boostrap_crayon.R: 100.00% +#> R/boostrap_fs.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/config.R: 100.00% #> R/disable_autoload.R: 100.00% +#> R/globals.R: 100.00% #> R/golem-yaml-utils.R: 100.00% #> R/is_golem.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% +#> R/with_opt.R: 100.00% ``` -## Tool series - -This package is part of a series of tools for Shiny, which includes: - -- `{golem}` - -- `{shinipsum}` - -- `{fakir}` - -- `{gemstones}` - - -## Resources - -### The Book : - -- - -- [paper version of the book “Engineering Production-Grade Shiny - Apps”](https://www.routledge.com/Engineering-Production-Grade-Shiny-Apps/Fay-Rochette-Guyader-Girard/p/book/9780367466022) - -### Blog posts : - -*Building Big Shiny Apps* - -- Part 1: - -- Part 2: - - -[*Make a Fitness App from -scratch*](https://towardsdatascience.com/production-grade-r-shiny-with-golem-prototyping-51b03f37c2a9) - -### Slide decks - -- useR! 2019 : [A Framework for Building Robust & Production Ready Shiny - Apps](https://github.com/VincentGuyader/user2019/raw/master/golem_Vincent_Guyader_USER!2019.pdf) -- ThinkR x RStudio Roadshow,Paris : [Production-grade Shiny Apps with - {golem}](https://speakerdeck.com/colinfay/production-grade-shiny-apps-with-golem) -- rstudio::conf(2020) : [Production-grade Shiny Apps with - golem](https://speakerdeck.com/colinfay/rstudio-conf-2020-production-grade-shiny-apps-with-golem) -- barcelonar (2019-12-03) : [Engineering Production-Grade Shiny Apps - with - {golem}](https://www.barcelonar.org/presentations/BarcelonaR_Building_Production_Grade_Shiny_Apps_with_golem.pdf) - -### Video - -- [{golem} and Effective Shiny Development - Methods](https://www.youtube.com/watch?v=OU1-CkSVdTI) -- [Hands-on demonstration of - {golem}](https://www.youtube.com/watch?v=3-p9XLvoJV0) -- useR! 2019 : [A Framework for Building Robust & Production Ready Shiny - Apps](https://youtu.be/tCAan6smrjs) -- 🇫🇷 [Introduction to {golem}](https://youtu.be/6qI4NzxlAFU) -- rstudio::conf(2020) : [Production-grade Shiny Apps with - golem](https://posit.co/resources/videos/production-grade-shiny-apps-with-golem/) -- 🇫🇷 Rencontres R 2021 : [Conception d’applications Shiny avec - {golem}](https://www.youtube.com/watch?v=0f5Me1PFGDs) -- 🇫🇷 [Déploiement d’une application {shiny} dans docker avec {renv} et - {golem}](https://www.youtube.com/watch?v=diCG4t76k78) -- 🇫🇷 Rencontres R 2023 : [{golem} et {fusen}, construire des apps Shiny - robustes et faciles à - maintenir](https://www.youtube.com/watch?v=cYKsYBFIpX0) - -### Cheatsheet - -- [{golem} cheatsheet](https://thinkr.fr/golem_cheatsheet_v0.1.pdf) - -### Examples apps - -These are examples from the community. Please note that they may not -necessarily be written in a canonical fashion and may have been written -with different versions of `{golem}` or `{shiny}`. - -- -- -- -- - -You can also find apps at: - -- -- - -## Installation - -- You can install the stable version from CRAN with: - -``` r -install.packages("golem") -``` - -- You can install the development version from - [GitHub](https://github.com/Thinkr-open/golem) with: - -``` r -# install.packages("remotes") -remotes::install_github("Thinkr-open/golem") -``` - -## Launch the project - -Create a new package with the project template: - - - -## Step by step guide - -See full documentation in the {pkgdown} website: - -\[CRAN\] - -\[dev\] - -After project creation, you’ll land on `dev/01_start.R`. There are also -`dev/02_dev.R` and `dev/03_deploy.R` - -These files are used to keep a track of all the steps you’ll be -following while building your app. - -### Step 1 : Getting Started - -Read [the Getting -Started](https://thinkr-open.github.io/golem/articles/a_start.html) -Vignette for a detailed walkthrough. - -### Step 2 : Day to Day Dev - -Read [Day to Day -Dev](https://thinkr-open.github.io/golem/articles/b_dev.html) Vignette -for a detailed walkthrough. - -### Step 3: deploy - -Read [Deploying Apps with -{golem}](https://thinkr-open.github.io/golem/articles/c_deploy.html) -Vignette for a detailed walkthrough. - ## CoC Please note that this project is released with a [Contributor Code of