golem

A Framework for Building Robust Shiny Apps

https://github.com/thinkr-open/golem

Science Score: 36.0%

This score indicates how likely this project is to be science-related based on various indicators:

○
CITATION.cff file
✓
codemeta.json file
Found codemeta.json file
✓
.zenodo.json file
Found .zenodo.json file
○
DOI references
○
Academic publication links
✓
Committers with academic emails
6 of 51 committers (11.8%) from academic institutions
○
Institutional organization owner
○
JOSS paper metadata
○
Scientific vocabulary similarity
Low similarity (18.2%) to scientific vocabulary

Keywords

golemverse hacktoberfest r r-package shiny shiny-apps shiny-r shinyapps

Keywords from Contributors

correlation network-graph standardization

Last synced: 9 months ago · JSON representation

Repository

A Framework for Building Robust Shiny Apps

Basic Info

Host: GitHub
Owner: ThinkR-open
License: other
Language: R
Default Branch: master
Homepage: https://thinkr-open.github.io/golem/
Size: 5.91 MB

Statistics

Stars: 932
Watchers: 22
Forks: 136
Open Issues: 51
Releases: 11

Topics

golemverse hacktoberfest r r-package shiny shiny-apps shiny-r shinyapps

Created about 8 years ago · Last pushed 9 months ago

Metadata Files

Readme Changelog Contributing License Code of conduct

README.Rmd

---
output: github_document
---



```{r setup, include = FALSE}
knitr::opts_chunk$set(
  collapse = TRUE,
  eval = TRUE,
  comment = "#>",
  fig.path = "man/figures/README-",
  out.width = "100%",
  fig.align = "center"
)
```



```{r echo = FALSE}
name_branch <- gert::git_branch()
link_to_branch_svg <- paste0(
  "https://codecov.io/gh/ThinkR-open/golem/branch/",
  name_branch,
  "/graph/badge.svg"
)
link_to_branch_html <- paste0(
  "https://app.codecov.io/github/ThinkR-open/golem/tree/",
  name_branch
)
```

```{r, echo = FALSE, results = "asis"}
cat("[![Lifecycle: stable](https://img.shields.io/badge/lifecycle-stable-brightgreen.svg)](https://lifecycle.r-lib.org/articles/stages.html)")
cat("[![R-CMD-check](https://github.com/ThinkR-open/golem/workflows/R-CMD-check/badge.svg)](https://github.com/ThinkR-open/golem/actions)")
cat(paste0("\n[![Coverage status](", link_to_branch_svg, ")](", link_to_branch_html, ")"))
cat("[![CRAN status](https://www.r-pkg.org/badges/version/golem)](https://cran.r-project.org/package=golem)")
```

 

# {golem} 

> You're reading the doc about version: `r pkgload::pkg_version()`. Note that `{golem}` follows the [semantic versioning](https://semver.org/) scheme.

Production-grade `{shiny}` applications, from creation to deployment.

`{golem}` is an opinionated framework that sets the standard for building production-grade `{shiny}` applications. It provides a structured environment that enforces best practices, fosters maintainability, and ensures your applications are reliable, and ready for deployment in real-world environments.

With `{golem}`, developers can focus on creating high-quality, robust `{shiny}` apps with confidence, knowing that the framework guides them through every step of the development process.

## 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") # Stable development version
# remotes::install_github("Thinkr-open/golem@dev") # Bleeding edge development version
```

## Get Started

Create a new app with the project template from RStudio:

```{r, echo=FALSE, out.width="80%", eval=TRUE}
knitr::include_graphics("https://raw.githubusercontent.com/ThinkR-open/golem/master/inst/img/golemtemplate.png")
```

Or use the `golem::create_golem()` function:

``` r
golem::create_golem("myapp")
```

See your app in action by running `golem::run_dev()` function.

Then, follow the scripts at:

- `dev/01_start.R` to configure your project at launch
- `dev/02_dev.R` for day to day development
- `dev/03_deploy.R` to build the deployment enabler for your app

## Resources

The `{golem}` package is part of the [`{golemverse}`](https://golemverse.org/), a series of tools for building production `{shiny}` apps.

A list of various `{golem}` related resources (tutorials, video, blog post,...) can be found [here](https://golemverse.org/resources/), along with blogposts, and links to other packages of the `golemverse`.

---

## Dev part

This `README` has been compiled on the

```{r}
Sys.time()
```

Here are the test & coverage results:

```{r error = TRUE}
devtools::check(quiet = TRUE)
```

```{r echo = FALSE}
unloadNamespace("golem")
```

```{r error = TRUE}
Sys.setenv("NOT_CRAN" = TRUE)
covr::package_coverage()
```

## 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()
})
```

Owner

Name: ThinkR
Login: ThinkR-open
Kind: organization
Email: welcome@thinkr.fr
Location: France

Website: https://thinkr.fr
Twitter: thinkR_fr
Repositories: 115
Profile: https://github.com/ThinkR-open

R Engineering, training, and consulting

GitHub Events

Total

Issues event: 34
Watch event: 33
Issue comment event: 76
Push event: 83
Pull request review event: 15
Pull request review comment event: 48
Pull request event: 29
Fork event: 5
Create event: 12

Last Year

Issues event: 34
Watch event: 33
Issue comment event: 76
Push event: 83
Pull request review event: 15
Pull request review comment event: 48
Pull request event: 29
Fork event: 5
Create event: 12

Committers

Last synced: about 1 year ago

All Time

Total Commits: 1,546
Total Committers: 51
Avg Commits per committer: 30.314
Development Distribution Score (DDS): 0.36

Past Year

Commits: 246
Committers: 5
Avg Commits per committer: 49.2
Development Distribution Score (DDS): 0.098

Top Committers

Name	Email	Commits
colin	c**n@t**r	990
Vincent Guyader	v**t@t**r	245
IlyaZar	z**n@w**e	60
statnmap	s****p	34
novica	n**a@g**m	33
Arthur Bréant	a**r@t**r	30
ALanguillaume	a**e@g**m	21
Swechhya	s**a@l**m	16
Ziwei Ye	z**7@r**u	15
cervangirard	c**d@g**m	15
ArthurData	a**r@c**m	12
DivadNojnarg	d**n@y**m	11
Richard Pilbery	t**9@R**n	5
Kok Ben Toh	k**t@u**u	4
Jonathan Sidi	y**s@m**m	4
Chase Clark	c**2@u**u	3
Ihaddaden Mohamed El Fodil	i**l@g**m	3
Yohann Msx	y**n@t**r	2
Mauricio Vargas	m**1@u**l	2
unknown	t**c@g**m	2
fmmattioni	f**2@g**m	2
Margot Brard	m**t@t**r	2
Kasper Thystrup Karstensen	k**a@g**m	2
Ivo Kwee	i**e@g**m	2
Eric Nantz	t**t@g**m	2
Ben Waite	w**5@g**m	2
Antoine Sachet	a**c@g**m	2
Abi Dawson	a**7@g**m	2
Stephen Holsenbeck	s**n@v**o	1
Vinicius Melquíades de Sousa	v**4@g**m	1
and 21 more...

Committer Domains (Top 20 + Academic)

thinkr.fr: 5 wiso.uni-koeln.de: 1 lftechnology.com: 1 rit.edu: 1 critizr.com: 1 ymail.com: 1 richards-imac.lan: 1 ufl.edu: 1 metrumrg.com: 1 uic.edu: 1 uc.cl: 1 virgalabs.io: 1 med.lu.se: 1 hu-berlin.de: 1 gmx.net: 1 inrae.fr: 1 myuct.ac.za: 1 goossens.me: 1

Issues and Pull Requests

Last synced: 9 months ago

All Time

Total issues: 168
Total pull requests: 202
Average time to close issues: about 1 year
Average time to close pull requests: about 2 months
Total issue authors: 63
Total pull request authors: 16
Average comments per issue: 2.31
Average comments per pull request: 0.68
Merged pull requests: 155
Bot issues: 0
Bot pull requests: 0

Past Year

Issues: 18
Pull requests: 30
Average time to close issues: 16 days
Average time to close pull requests: 3 days
Issue authors: 11
Pull request authors: 6
Average comments per issue: 1.56
Average comments per pull request: 0.6
Merged pull requests: 19
Bot issues: 0
Bot pull requests: 0

View more stats

Top Authors

Issue Authors

ColinFay (55)
ilyaZar (19)
VincentGuyader (7)
YonghuiDong (5)
gabrielburcea (5)
ArthurData (4)
asadow (3)
statnmap (3)
LDSamson (3)
howardbaik (3)
dkalisch (2)
moodymudskipper (2)
yogat3ch (2)
DevIA05 (2)
jzadra (2)

Pull Request Authors

ColinFay (82)
ilyaZar (42)
VincentGuyader (39)
ArthurData (18)
pachadotdev (3)
ALanguillaume (3)
statnmap (3)
yogat3ch (2)
ymansiaux (2)
olivroy (2)
ivokwee (1)
ni2scmn (1)
ncullen93 (1)
Cervangirard (1)
howardbaik (1)

Top Labels

Issue Labels

bug (53) enhancement (25) PR opened :eyeglasses: (7) documentation (6) timed-1h (6) WIP :running_woman: (5) hacktoberfest (5) work-next (5) help wanted (4) Difficulty: intermediate (3) effort: low (3) good first issue (3) effort: medium (2) effort: high (2) Difficulty: novice (2) time-3h30 (2) timed-1day (1) Difficulty: advanced (1) on-hold (1)

Pull Request Labels

on-hold (3) hacktoberfest-accepted (2)

Packages

Total packages: 4
Total downloads:
- cran 6,260 last-month
Total docker downloads: 154,416

Total dependent packages: 40
(may contain duplicates)
Total dependent repositories: 442
(may contain duplicates)
Total versions: 42
Total maintainers: 1

cran.r-project.org: golem

A Framework for Robust Shiny Applications

Homepage: https://thinkr-open.github.io/golem/
Documentation: http://cran.r-project.org/web/packages/golem/golem.pdf
License: MIT + file LICENSE
Latest release: 0.5.1
published almost 2 years ago

Versions: 12
Dependent Packages: 40
Dependent Repositories: 441
Downloads: 6,260 Last month
Docker Downloads: 154,416

Rankings

Stargazers count: 0.3%

Forks count: 0.5%

Dependent repos count: 0.7%

Dependent packages count: 2.1%

Downloads: 5.1%

Average: 5.4%

Docker downloads count: 23.6%

Maintainers (1)

contact@colinfay.me

Last synced: 9 months ago

proxy.golang.org: github.com/thinkr-open/golem

Documentation: https://pkg.go.dev/github.com/thinkr-open/golem#section-documentation
License: other
Latest release: v0.5.1
published almost 2 years ago

Versions: 11
Dependent Packages: 0
Dependent Repositories: 0

Rankings

Dependent packages count: 5.4%

Average: 5.6%

Dependent repos count: 5.8%

Last synced: 9 months ago

proxy.golang.org: github.com/ThinkR-open/golem

Documentation: https://pkg.go.dev/github.com/ThinkR-open/golem#section-documentation
License: other
Latest release: v0.5.1
published almost 2 years ago

Versions: 11
Dependent Packages: 0
Dependent Repositories: 0

Rankings

Dependent packages count: 5.4%

Average: 5.6%

Dependent repos count: 5.8%

Last synced: 9 months ago

conda-forge.org: r-golem

Homepage: https://github.com/ThinkR-open/golem
License: MIT
Latest release: 0.3.5
published over 3 years ago

Versions: 8
Dependent Packages: 0
Dependent Repositories: 1

Rankings

Stargazers count: 14.1%

Forks count: 16.4%

Dependent repos count: 24.4%

Average: 26.6%

Dependent packages count: 51.6%

Last synced: 9 months ago

Dependencies

DESCRIPTION cran

R >= 3.0 depends
attempt >= 0.3.0 imports
cli >= 2.0.0 imports
config * imports
crayon * imports
desc * imports
fs * imports
here * imports
htmltools * imports
pkgload * imports
roxygen2 * imports
rstudioapi * imports
shiny >= 1.5.0 imports
usethis >= 1.6.0 imports
utils * imports
yaml * imports
attachment * suggests
covr * suggests
devtools * suggests
dockerfiler >= 0.1.4 suggests
knitr * suggests
pkgbuild * suggests
pkgdown * suggests
processx * suggests
purrr * suggests
rcmdcheck * suggests
rlang * suggests
rmarkdown * suggests
rsconnect * suggests
spelling * suggests
stringr * suggests
testthat * suggests
tools * suggests
withr * suggests

inst/shinyexample/DESCRIPTION cran

config * imports
golem * imports
shiny * imports

tests/testthat/DESCRIPTION cran

golem * imports
shiny * imports

.github/workflows/check-standard.yaml actions

actions/cache v2 composite
actions/checkout v2 composite
actions/upload-artifact main composite
r-lib/actions/setup-pandoc v1 composite
r-lib/actions/setup-r v1 composite

.github/workflows/pkgdown.yaml actions

actions/cache v2 composite
actions/checkout v2 composite
r-lib/actions/setup-pandoc v1 composite
r-lib/actions/setup-r v1 composite

.github/workflows/pr-commands.yaml actions

actions/checkout v2 composite
r-lib/actions/pr-fetch v1 composite
r-lib/actions/pr-push v1 composite
r-lib/actions/setup-r v1 composite