{"id":14066196,"url":"https://github.com/EducationShinyAppTeam/boastUtils","last_synced_at":"2025-07-29T22:31:16.074Z","repository":{"id":41333847,"uuid":"212375671","full_name":"EducationShinyAppTeam/boastUtils","owner":"EducationShinyAppTeam","description":"R package for reusable items.","archived":false,"fork":false,"pushed_at":"2024-05-24T20:59:16.000Z","size":438,"stargazers_count":1,"open_issues_count":6,"forks_count":0,"subscribers_count":3,"default_branch":"master","last_synced_at":"2024-08-13T07:11:08.968Z","etag":null,"topics":["package"],"latest_commit_sha":null,"homepage":"","language":"R","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/EducationShinyAppTeam.png","metadata":{"files":{"readme":"README.Rmd","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2019-10-02T15:25:12.000Z","updated_at":"2024-06-14T18:44:27.000Z","dependencies_parsed_at":"2024-08-13T07:10:44.196Z","dependency_job_id":"05871e1e-001b-4104-9e32-7a238a409342","html_url":"https://github.com/EducationShinyAppTeam/boastUtils","commit_stats":null,"previous_names":[],"tags_count":3,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/EducationShinyAppTeam%2FboastUtils","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/EducationShinyAppTeam%2FboastUtils/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/EducationShinyAppTeam%2FboastUtils/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/EducationShinyAppTeam%2FboastUtils/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/EducationShinyAppTeam","download_url":"https://codeload.github.com/EducationShinyAppTeam/boastUtils/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":228052725,"owners_count":17862107,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["package"],"created_at":"2024-08-13T07:04:59.020Z","updated_at":"2024-12-04T05:31:29.614Z","avatar_url":"https://github.com/EducationShinyAppTeam.png","language":"R","funding_links":[],"categories":["R"],"sub_categories":[],"readme":"---\ntitle: \"BOAST Utilities\"\nauthor: EducationShinyAppTeam\ndate: February 26, 2021\noutput: github_document\n---\n\n\u003c!-- README.md is generated from README.Rmd. Please edit that file --\u003e\n\n```{r setup, include = FALSE}\nknitr::opts_chunk$set(\n  eval = FALSE,\n  collapse = TRUE,\n  comment = \"#\u003e\",\n  fig.path = \"man/figures/README-\",\n  out.width = \"100%\"\n)\n```\n\nUsed 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.\n\n## Installation\n\nYou can install this version of boastUtils from [GitHub](https://github.com/) with:\n\n```{r}\ndevtools::install_github(\"EducationShinyAppTeam/boastUtils\")\n```\n\n**Troubleshooting:**\n- [Error: (converted from warning) package 'xyz' was built under R version x.y.z](https://github.com/r-lib/remotes/issues/403#issuecomment-513891775)\n\nCreate an [issue](https://github.com/EducationShinyAppTeam/boastUtils/issues) if the problem is not solved by one of the above.\n\n## Creating an App\n\nOne 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`.\n\n**Example app.R**\n```{r}\nlibrary(boastUtils)\n\nui \u003c- fluidPage(\n  # ... ui definitions ...\n)\n\nserver \u003c- function(input, output, session){\n  # ... server logic ...\n}\n\nboastApp(ui = ui, server = server)\n```\n\n## Configuration\n\nWe currently have one config option available which disables xAPI logging.\n\n**Example app.R**\n```{r}\nboastApp(ui = ui, server = server, config = list(log = FALSE))\n```\n\n## Additional Configuration\n\nTo 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.\n\n**See also:**\n\n- `boastUtils:::.getConfig()`\n- https://cran.r-project.org/web/packages/httr/vignettes/api-packages.html#authentication\n\n**.Renviron**\n```{txt}\nDB_USER=\u003cDATABASE_USERNAME\u003e\nDB_PASSWORD=\u003cDATABASE_PASSWORD\u003e\nR_CONFIG_ACTIVE=rsconnect\n```\n\n**config.yml**\n```{yml}\ndefault:\n  database:\n    host: 'localhost'\n    transport: 'https'\n    port: NULL\n    user: 'root'\n    pwd: 'root'\n  \nrsconnect:\n  database:\n    host: 'dev.stat.vmhost.psu.edu/couch'\n    transport: 'https'\n    port: NULL\n    user: !expr Sys.getenv(\"DB_USER\")\n    pwd: !expr Sys.getenv(\"DB_PASSWORD\")\n```","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FEducationShinyAppTeam%2FboastUtils","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FEducationShinyAppTeam%2FboastUtils","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FEducationShinyAppTeam%2FboastUtils/lists"}