forked from ThinkR-open/golem
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathREADME.Rmd
180 lines (114 loc) · 6.28 KB
/
README.Rmd
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
---
output: github_document
---
<!-- README.md is generated from README.Rmd. Please edit that file -->
```{r setup, include = FALSE}
knitr::opts_chunk$set(
collapse = TRUE,
eval = TRUE,
comment = "#>",
fig.path = "man/figures/README-",
out.width = "100%",
fig.align = "center"
)
```
<!-- badges: start -->
[](https://lifecycle.r-lib.org/articles/stages.html) [](https://github.com/ThinkR-open/golem/actions) [](https://codecov.io/github/ThinkR-open/golem?branch=master) [](https://cran.r-project.org/package=golem)
<!-- badges: end -->
# {golem} <img src="https://raw.githubusercontent.com/ThinkR-open/golem/master/inst/rstudio/templates/project/golem.png" align="right" width="120"/>
`{golem}` is an opinionated framework for building production-grade shiny applications.
## About
You're reading the doc about version : `r pkgload::pkg_version()`
This README has been compiled on the
```{r}
Sys.time()
```
Here are the test & coverage results :
```{r}
devtools::check(quiet = TRUE)
```
```{r echo = FALSE}
unloadNamespace("golem")
```
```{r}
covr::package_coverage()
```
## Tool series
This package is part of a series of tools for Shiny, which includes:
- `{golem}` - <https://github.com/ThinkR-open/golem>
- `{shinipsum}` - <https://github.com/ThinkR-open/shinipsum>
- `{fakir}` - <https://github.com/ThinkR-open/fakir>
- `{gemstones}` - <https://github.com/ThinkR-open/gemstones>
## Resources
### The Book :
- <https://engineering-shiny.org/>
- [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: <https://rtask.thinkr.fr/building-big-shiny-apps-a-workflow-1/>
- Part 2: <https://rtask.thinkr.fr/building-big-shiny-apps-a-workflow-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)
- `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)
### 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}`.
- <https://github.com/seanhardison1/vcrshiny>
- <https://github.com/Nottingham-and-Nottinghamshire-ICS/healthcareSPC>
- <https://github.com/marton-balazs-kovacs/tenzing>
- <https://github.com/shahreyar-abeer/cranstars>
You can also find apps at:
- <https://connect.thinkr.fr/connect/>
- <https://github.com/ColinFay/golemexamples>
## 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:
```{r, echo=FALSE, out.width="80%", eval=TRUE}
knitr::include_graphics("https://raw.githubusercontent.com/ThinkR-open/golem/master/inst/img/golemtemplate.png")
```
## Step by step guide
See full documentation in the {pkgdown} website:
[CRAN] <https://thinkr-open.github.io/golem/>
[dev] <https://thinkr-open.github.io/golem/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 Conduct](https://www.contributor-covenant.org/version/1/0/0/code-of-conduct.html). By participating in this project you agree to abide by its terms.
## Note for the contributors
Please style the files according to `grkstyle::grk_style_transformer()`
```{r eval = FALSE}
# If you work in RStudio
options(styler.addins_style_transformer = "grkstyle::grk_style_transformer()")
# If you work in VSCode
options(languageserver.formatting_style = function(options) {
grkstyle::grk_style_transformer()
})
```