README.md

snapapps

Travis-CI Build Status AppVeyor Build Status Coverage Status

SNAPverse R package ecosystem development frozen.

Development of the SNAPverse R package ecosystem has been frozen indefinitely. This project was never directly funded. I began it out of personal interest, but no longer work for SNAP. It will remain archived here for historical reference.

The snapapps package contains a collection of open source Shiny apps by Matthew Leonawicz at the Scenarios Network for Alaska and Arctic Planning, University of Alaska Fairbanks. It is a member package in the apps and docs sector of the SNAPverse collection of R packages. Many of the apps in this package originate from the SNAP open source Shiny apps GitHub repository. Additional apps can be found in other related packages including snapdash, snapflex and snapdocs.

I am slowly adding more apps to this package. Like much of the SNAPverse, snapapps is currently an early work in progress.

Installation

You can install snapapps from github with:

# install.packages('devtools')
devtools::install_github("leonawicz/snapapps")

Running apps locally

The purpose of snapapps is to give you easy access to local instances of SNAP Shiny apps that you can run in your browser. By installing snapapps you have local access to a number of Shiny apps. You can launch apps by passing their respective IDs to snapp. For example, version four of the Distributions of Random Variables app:

library(snapapps)
snapp("rv4")

The package also gives you access to app source code if you are an R user who learns by digging and is comfortable going through package source files. An easy way to view the source code is side by side or directly below the app content in your browser by running the app in showcase mode. Showcase mode will also present additional, concise app metadata and description.

snapp("rv4", local_mode = "showcase")

However, you may still find it much more convenient in this regard to simply fork the GitHub repository where most of the apps in snapapps originate. Showcase mode will also not display equally well for all apps, depending on how they are organized and presented in the browser.

App information

The list of app IDs can be obtained with snapps, which provides information about all of the apps in the collection. This function returns a data frame with columns that include app ID and short descriptions as well as a number of other pieces of relevant metadata. See the snapps help documentation or the package vignette for details.

snapps()
#> # A tibble: 9 x 10
#>   id    name  description published revised rating status aws   url  
#>   <chr> <chr> <chr>           <dbl>   <dbl> <fct>  <chr>  <lgl> <chr>
#> 1 rv    RV d~ Distributi~      2017    2017 Begin~ compl~ FALSE http~
#> 2 twe   Temp~ Coastal Al~      2013    2017 Inter~ compl~ TRUE  http~
#> 3 sic   Sea ~ Alaska sea~      2013    2017 Inter~ compl~ TRUE  http~
#> 4 siw   Sea ~ Coastal Al~      2013    2017 Inter~ compl~ TRUE  http~
#> 5 rv1   RV d~ Distributi~      2013    2017 Begin~ compl~ FALSE http~
#> 6 rv2   RV d~ Distributi~      2013    2017 Begin~ compl~ FALSE http~
#> 7 rv3   RV d~ Distributi~      2013    2017 Begin~ compl~ FALSE http~
#> 8 rv4   RV d~ Distributi~      2013    2017 Begin~ compl~ FALSE http~
#> 9 tring Tree~ Climate an~      2013    2017 Begin~ compl~ FALSE http~
#> # ... with 1 more variable: redirect <chr>

Accessing live versions online

One piece of information that is particularly useful is the canonical live link for an app. Currently, most SNAP Shiny apps are hosted on RStudio's shinyapps.io platform. While these URLs appear in the metadata table, they can also be launched directly by passing source = "remote" to snapp.

snapp("rv4", source = "remote")

This will again launch the app in your browser, but this time via the canonical URL. Apps hosted remotely on shinyapps.io generally take notably longer to load than local apps. This is another convenience of snapapps.

One drawback is that some apps are too large to include in official form in snapapps as a consequence of the amount of data they use, or more likely, the amount of data they require access to. For example, an app may access data from a large data repository on Amazon Web Services using private keys that are not included in this package. For such an app to run locally, it must have a copy of the data stored with it. In order to include these apps in the package, the data is cut drastically down to almost nothing. The app will be the same, but the data it offers is a shell in comparison to the canonical version hosted online.

Reference

Complete package reference and function documentation



leonawicz/snapapps documentation built on Sept. 8, 2018, 11:32 p.m.