https://github.com/RinteRface/truelle
R package providing a gadget to seamlessly initialise robust shiny related projects
https://github.com/RinteRface/truelle
Last synced: 5 months ago
JSON representation
R package providing a gadget to seamlessly initialise robust shiny related projects
- Host: GitHub
- URL: https://github.com/RinteRface/truelle
- Owner: RinteRface
- License: other
- Created: 2021-06-03T10:10:41.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2021-07-09T10:36:30.000Z (almost 4 years ago)
- Last Synced: 2024-12-04T05:22:41.704Z (5 months ago)
- Language: R
- Size: 1.53 MB
- Stars: 25
- Watchers: 4
- Forks: 2
- Open Issues: 2
-
Metadata Files:
- Readme: README.Rmd
- Changelog: NEWS.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
- jimsghstars - RinteRface/truelle - R package providing a gadget to seamlessly initialise robust shiny related projects (R)
README
---
output: github_document
---```{r, include = FALSE}
knitr::opts_chunk$set(
collapse = TRUE,
comment = "#>",
#fig.path = "man/figures/README-",
out.width = "100%"
)
```# truelle
The goal of `{truelle}` is to provide a GUI to the `{golem}` package and many more.
## Installation
You can install the released version of truelle from [CRAN](https://CRAN.R-project.org) with:
``` r
remotes::install_github("RinteRface/truelle")
```## Workflow example
This is a basic example which shows you how to start the `{truelle}` GUI:
```{r, eval=FALSE, example}
library(truelle)
run_app()
```### Step 1: project type
Select __Package__ and choose the `{golem}` engine.
```{r, echo = FALSE, fig.show="hold", out.width="50%"}
knitr::include_graphics("man/figures/truelle-project-type.png")
knitr::include_graphics("man/figures/truelle-project-engine.png")
```### Step 2: options
Provide a valid package path and review project options.
```{r, echo = FALSE, out.width='50%', fig.align='center'}
knitr::include_graphics("man/figures/truelle-package-options.png")
```### Step 3: UI layout
Select the Shiny layout of your choice.
```{r, echo = FALSE, out.width='50%', fig.align='center'}
knitr::include_graphics("man/figures/truelle-ui-template.png")
```### Step 4: code output
Click on the `r emo::ji("play")` button or copy/paste `r emo::ji("photo")` the code to your terminal...
```{r, echo = FALSE, fig.show="hold", out.width="50%"}
knitr::include_graphics("man/figures/truelle-output.png")
knitr::include_graphics("man/figures/golem-package-structure.png")
```### Step 5: develop
- Open the new project.
- Run `devtools::load_all()`.
- Enjoy ...## Disclaimer
For now, only the `{golem}` workflow is supported.