https://github.com/EducationShinyAppTeam/boastUtils
R package for reusable items.
https://github.com/EducationShinyAppTeam/boastUtils
package
Last synced: 4 months ago
JSON representation
R package for reusable items.
- Host: GitHub
- URL: https://github.com/EducationShinyAppTeam/boastUtils
- Owner: EducationShinyAppTeam
- License: gpl-2.0
- Created: 2019-10-02T15:25:12.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2024-05-24T20:59:16.000Z (11 months ago)
- Last Synced: 2024-08-13T07:11:08.968Z (8 months ago)
- Topics: package
- Language: R
- Homepage:
- Size: 428 KB
- Stars: 1
- Watchers: 3
- Forks: 0
- Open Issues: 6
-
Metadata Files:
- Readme: README.Rmd
- License: LICENSE.txt
Awesome Lists containing this project
- jimsghstars - EducationShinyAppTeam/boastUtils - R package for reusable items. (R)
README
---
title: "BOAST Utilities"
author: EducationShinyAppTeam
date: February 26, 2021
output: github_document
---
```{r setup, include = FALSE}
knitr::opts_chunk$set(
eval = FALSE,
collapse = TRUE,
comment = "#>",
fig.path = "man/figures/README-",
out.width = "100%"
)
```
Used to provide reusable [components](https://shiny.rstudio.com/articles/html-tags.html), [gadgets](https://shiny.rstudio.com/articles/gadgets.html), and [modules](https://shiny.rstudio.com/articles/modules.html) for the [BOAST](https://github.com/EducationShinyAppTeam/BOAST) project.
## Installation
You can install this version of boastUtils from [GitHub](https://github.com/) with:
```{r}
devtools::install_github("EducationShinyAppTeam/boastUtils")
```
**Troubleshooting:**
- [Error: (converted from warning) package 'xyz' was built under R version x.y.z](https://github.com/r-lib/remotes/issues/403#issuecomment-513891775)
Create an [issue](https://github.com/EducationShinyAppTeam/boastUtils/issues) if the problem is not solved by one of the above.
## Creating an App
One way to accomplish serving a more standardized codebase was to provide a wrapper for the default [shinyApp](https://shiny.rstudio.com/reference/shiny/latest/shinyApp.html) function. Instead of including the `shiny` package, include `boastUtils` and write your app as normal. Be sure to replace `shinyApp` with `boastApp`.
**Example app.R**
```{r}
library(boastUtils)
ui <- fluidPage(
# ... ui definitions ...
)
server <- function(input, output, session){
# ... server logic ...
}
boastApp(ui = ui, server = server)
```
## Configuration
We currently have one config option available which disables xAPI logging.
**Example app.R**
```{r}
boastApp(ui = ui, server = server, config = list(log = FALSE))
```
## Additional Configuration
To connect with services such as CouchDB for persistent storage, place details in an environment variable using `appDir/inst/.Renviron`. This information is then pulled into `boastUtils/inst/config.yml` on app startup. These details are meant to be kept private and should not be pushed to GitHub.
**See also:**
- `boastUtils:::.getConfig()`
- https://cran.r-project.org/web/packages/httr/vignettes/api-packages.html#authentication
**.Renviron**
```{txt}
DB_USER=
DB_PASSWORD=
R_CONFIG_ACTIVE=rsconnect
```
**config.yml**
```{yml}
default:
database:
host: 'localhost'
transport: 'https'
port: NULL
user: 'root'
pwd: 'root'
rsconnect:
database:
host: 'dev.stat.vmhost.psu.edu/couch'
transport: 'https'
port: NULL
user: !expr Sys.getenv("DB_USER")
pwd: !expr Sys.getenv("DB_PASSWORD")
```