https://github.com/mjfrigaard/shinypak
R package (code examples for Shiny App-Packages book)
https://github.com/mjfrigaard/shinypak
Last synced: 3 months ago
JSON representation
R package (code examples for Shiny App-Packages book)
- Host: GitHub
- URL: https://github.com/mjfrigaard/shinypak
- Owner: mjfrigaard
- Created: 2023-11-19T06:26:38.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-07-26T21:04:48.000Z (7 months ago)
- Last Synced: 2024-08-13T07:11:12.411Z (6 months ago)
- Language: R
- Homepage: https://mjfrigaard.github.io/shinypak/
- Size: 35.6 MB
- Stars: 3
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.Rmd
- Changelog: NEWS.md
Awesome Lists containing this project
- jimsghstars - mjfrigaard/shinypak - R package (code examples for Shiny App-Packages book) (R)
README
---
output: github_document
---
```{r, include = FALSE}
options(
repos = "https://packagemanager.rstudio.com/all/__linux__/focal/latest")
knitr::opts_chunk$set(
collapse = TRUE,
comment = "#>",
fig.path = "man/figures/",
out.width = "100%"
)
```
# `shinypak`
The primary goal of `shinypak` is to provide easy access all the application examples in [`shinyAppPkgs`](https://github.com/mjfrigaard/shinyAppPkgs).[^all-apps]
[^all-apps]: Each of the apps in `shinypak` have a corresponding chapter in [Shiny App-Packages](https://mjfrigaard.github.io/shiny-app-pkgs/) and branch in the [shinyAppPkgs repo](https://github.com/mjfrigaard/shinyAppPkgs/branches/all).
`shinypak` also has helper functions for checking the files and folders in a Shiny app-package.
## Installation
You can install the development version of `shinypak` from [GitHub](https://github.com/) after installing `remotes`:
```{r remotes, message=FALSE, warning=FALSE, results='hide', eval=FALSE}
install.packages('remotes')
remotes::install_github("mjfrigaard/shinypak")
```
```{r pkg, message=FALSE, warning=FALSE, results='hide'}
library(shinypak)
```
## Git/GitHub configuration
`shinypak` uses the [`gert` package](https://docs.ropensci.org/gert/) for Git/GitHub management (and assumes authentication was done automatically using the `credentials` package).[^credentials]
[^credentials]: Check out the documentation for the [`credentials` package](https://docs.ropensci.org/credentials/articles/intro.html)
## Available app-packages
The applications in `shinypak` are from the chapters of the [Shiny App-Packages book](https://bit.ly/ShinyAppPkgs). A full list of the available apps and topics are available in `topic_lookup`:
```{r head-topic_lookup, eval=TRUE}
knitr::kable(
head(topic_lookup, 10)
)
```
```{r tail-topic_lookup, eval=TRUE}
knitr::kable(
tail(topic_lookup, 10)
)
```
## Launching apps and app-packages
Launch an application from any section in the book using:
```{r , eval=FALSE}
launch(app = "02.3_proj-app")
```
```{r launch, echo=FALSE, out.width='100%', fig.align='center'}
knitr::include_graphics("man/figures/launch_readme.gif")
```