RInno makes it easy to install local shiny apps by providing an interface between R, Inno Setup, an installer for Windows programs (sorry Mac and Linux users), and Electron, a modern desktop framework used by companies like Github, Slack, Microsoft, Facebook and Docker. RInno is designed to be simple to use (two lines of code at a minimum), yet comprehensive.
If a user does not have R installed, the RInno installer can be configured to ask them to install R along with a shiny app, include_R = TRUE. And similar to Dr. Lee Pang’s DesktopDeployR project, RInno provides a framework for managing software dependencies and error logging features. However, RInno also supports GitHub package dependencies, continuous installation (auto-update on start up), and it is easier to manage with create_app, the main RInno function. DesktopDeployR requires many manual adjustments and a deep understanding of the entire framework to use, but RInno can be learned incrementally and changes automatically flow down stream. You don’t need to remember the 100+ places impacted by changing app_dir. RInno only requires a high-level understanding of what you’d like to accomplish.
create_app passes its arguments to most of the other support functions in RInno. You can (and probably should) specify most things there and they will get passed on. Alternatively, you can provide instructions directly to those support functions like this:
# Copy installation scripts (JavaScript, icons, infobefore.txt, package_manager.R, app.R)
+# Copy installation scripts (JavaScript, icons, infobefore.txt, package_manager.R, launch_app.R)
copy_installation(app_dir = "my/app/path")
# If your users need R installed:
diff --git a/inst/installation/ensure.R b/inst/installation/ensure.R
index 0583542..1500b9a 100644
--- a/inst/installation/ensure.R
+++ b/inst/installation/ensure.R
@@ -4,9 +4,6 @@ installed_pkgs = data.frame(installed.packages(applibpath), stringsAsFactors = F
ensure <- function(pkgs, lib_loc = applibpath) {
pkg_names <- gsub("_.*", "", basename(pkgs))
- start <- attr(regexpr(".*_", pkgs), "match.length") + 1
- stop <- attr(regexpr(".*", pkgs), "match.length") - 4
- pkg_version <- substr(pkgs, start, stop)
for (i in seq_along(pkgs)) {
setWinProgressBar(pb,
diff --git a/inst/installation/app.R b/inst/installation/launch_app.R
similarity index 96%
rename from inst/installation/app.R
rename to inst/installation/launch_app.R
index 0a0d418..fb2d2fe 100644
--- a/inst/installation/app.R
+++ b/inst/installation/launch_app.R
@@ -1,97 +1,97 @@
-# app launching code
-config <- jsonlite::fromJSON("utils/config.cfg")
-reg_paths <- jsonlite::fromJSON("utils/regpaths.json")
-
-# This function is used to apply the web browser configuration and registry
-# information on app start up. If a user does not have the user browser,
-# their defult browser will be used.
-start_app <- function(
- app_name = config$appname,
- user_browser = config$user_browser,
- chrome = reg_paths$chrome,
- ff = reg_paths$ff,
- ie = reg_paths$ie,
- electron = config$nativefier) {
-
- if (user_browser == "electron") {
- electron <- gsub("/", "\\\\", electron)
-
- } else if (user_browser == "chrome") {
- if (chrome != "none") {
- chrome <- gsub("\\\\", "/", file.path(chrome, "chrome.exe", fsep = "\\"))
- options(browser = chrome)
- launch_browser = TRUE
- }
-
- } else if (user_browser == "firefox") {
- if (ff != "none") {
- ff <- gsub("\\\\", "/", file.path(ff, "firefox.exe", fsep = "\\"))
- options(browser = ff)
- launch_browser = TRUE
- }
-
- } else if (user_browser == "ie") {
- if (ie != "none") {
- ie <- gsub("\\\\", "/", ie)
- options(browser = ie)
- launch_browser = TRUE
- }
- }
-
- # If a repo has been provided, use the app in your package
- if (config$app_repo[[1]] != "none") {
- app_path <- file.path(system.file(package = config$appname), "app")
-
- # flexdashboard
- if (config$flex_file != "none") {
- if (Sys.getenv("RSTUDIO_PANDOC") == "") {
- Sys.setenv(RSTUDIO_PANDOC = gsub("\\\\", "/", reg_paths$pandoc))
- }
- rmarkdown::run(
- file = file.path(app_path, config$flex_file),
- shiny_args = list(
- host = '0.0.0.0',
- launch.browser = launch_browser,
- port = 1984
- )
- )
-
- # Shiny
- } else {
- shiny::runApp(app_path, launch.browser = launch_browser, port = 1984)
- }
-
- } else {
- # flexdashboard
- if (config$flex_file != "none") {
- if (Sys.getenv("RSTUDIO_PANDOC") == "") {
- Sys.setenv(RSTUDIO_PANDOC = gsub("\\\\", "/", reg_paths$pandoc))
- }
-
- rmarkdown::run(
- file = paste0("./", config$flex_file),
- shiny_args = list(
- host = '0.0.0.0',
- launch.browser = launch_browser,
- port = 1984
- )
- )
-
- # Shiny
- } else {
- if (user_browser == "electron") {
- # start app
- # applibpath variable is set in package_manager.R
- # OPT: use `dput` to copy whole .libPaths() and .GlobalEnv contents
- system(sprintf('R -e ".libPaths(c(\'%s\', .libPaths())); shiny::runApp(\'./\', port=1984)"', applibpath), wait = FALSE)
- # start electron
- system(sprintf('cmd /C "%s"', electron), wait = FALSE)
-
- } else {
- shiny::runApp("./", launch.browser = launch_browser, port = 1984)
- }
- }
- }
-}
-
-start_app()
+# app launching code
+config <- jsonlite::fromJSON("utils/config.cfg")
+reg_paths <- jsonlite::fromJSON("utils/regpaths.json")
+
+# This function is used to apply the web browser configuration and registry
+# information on app start up. If a user does not have the user browser,
+# their defult browser will be used.
+start_app <- function(
+ app_name = config$appname,
+ user_browser = config$user_browser,
+ chrome = reg_paths$chrome,
+ ff = reg_paths$ff,
+ ie = reg_paths$ie,
+ electron = config$nativefier) {
+
+ if (user_browser == "electron") {
+ electron <- gsub("/", "\\\\", electron)
+
+ } else if (user_browser == "chrome") {
+ if (chrome != "none") {
+ chrome <- gsub("\\\\", "/", file.path(chrome, "chrome.exe", fsep = "\\"))
+ options(browser = chrome)
+ launch_browser = TRUE
+ }
+
+ } else if (user_browser == "firefox") {
+ if (ff != "none") {
+ ff <- gsub("\\\\", "/", file.path(ff, "firefox.exe", fsep = "\\"))
+ options(browser = ff)
+ launch_browser = TRUE
+ }
+
+ } else if (user_browser == "ie") {
+ if (ie != "none") {
+ ie <- gsub("\\\\", "/", ie)
+ options(browser = ie)
+ launch_browser = TRUE
+ }
+ }
+
+ # If a repo has been provided, use the app in your package
+ if (config$app_repo[[1]] != "none") {
+ app_path <- file.path(system.file(package = config$appname), "app")
+
+ # flexdashboard
+ if (config$flex_file != "none") {
+ if (Sys.getenv("RSTUDIO_PANDOC") == "") {
+ Sys.setenv(RSTUDIO_PANDOC = gsub("\\\\", "/", reg_paths$pandoc))
+ }
+ rmarkdown::run(
+ file = file.path(app_path, config$flex_file),
+ shiny_args = list(
+ host = '0.0.0.0',
+ launch.browser = launch_browser,
+ port = 1984
+ )
+ )
+
+ # Shiny
+ } else {
+ shiny::runApp(app_path, launch.browser = launch_browser, port = 1984)
+ }
+
+ } else {
+ # flexdashboard
+ if (config$flex_file != "none") {
+ if (Sys.getenv("RSTUDIO_PANDOC") == "") {
+ Sys.setenv(RSTUDIO_PANDOC = gsub("\\\\", "/", reg_paths$pandoc))
+ }
+
+ rmarkdown::run(
+ file = paste0("./", config$flex_file),
+ shiny_args = list(
+ host = '0.0.0.0',
+ launch.browser = launch_browser,
+ port = 1984
+ )
+ )
+
+ # Shiny
+ } else {
+ if (user_browser == "electron") {
+ # start app
+ # applibpath variable is set in package_manager.R
+ # OPT: use `dput` to copy whole .libPaths() and .GlobalEnv contents
+ system(sprintf('R -e ".libPaths(c(\'%s\', .libPaths())); shiny::runApp(\'./\', port=1984)"', applibpath), wait = FALSE)
+ # start electron
+ system(sprintf('cmd /C "%s"', electron), wait = FALSE)
+
+ } else {
+ shiny::runApp("./", launch.browser = launch_browser, port = 1984)
+ }
+ }
+ }
+}
+
+start_app()
diff --git a/inst/installation/package_manager.R b/inst/installation/package_manager.R
index 15b652c..843ceb4 100644
--- a/inst/installation/package_manager.R
+++ b/inst/installation/package_manager.R
@@ -70,7 +70,7 @@ appexit_msg <- tryCatch({
close(pb)
# Start the app
- source(file.path(appwd, "utils/app.R"))
+ source(file.path(appwd, "utils/launch_app.R"))
"application terminated normally"
},
diff --git a/man/copy_installation.Rd b/man/copy_installation.Rd
index 6a57561..aced8a7 100644
--- a/man/copy_installation.Rd
+++ b/man/copy_installation.Rd
@@ -15,7 +15,7 @@ copy_installation(app_dir = getwd(), overwrite = TRUE)
This function moves files stored in \code{system.file('installation', package = 'RInno')} to \code{app_dir}:
\itemize{
\item Icons for installer and app, \emph{setup.ico}, \emph{default.ico} and \emph{default.png}.
- \item Files that manage app start up, \emph{utils/package_manager.R} and \emph{utils/app.R}.
+ \item Files that manage app start up, \emph{utils/package_manager.R} and \emph{utils/launch_app.R}.
\item First/last page of the installation wizard, \emph{infobefore.txt} and \emph{infoafter.txt}.
\item Batch support files, \emph{utils/wsf/run.wsf}, \emph{utils/wsf/js/run.js}, \emph{utils/wsf/js/json2.js}, and \emph{utils/wsf/js/JSON.minify.js}.
}
diff --git a/man/cran_version.Rd b/man/cran_version.Rd
deleted file mode 100644
index 7a6784d..0000000
--- a/man/cran_version.Rd
+++ /dev/null
@@ -1,23 +0,0 @@
-% Generated by roxygen2: do not edit by hand
-% Please edit documentation in R/utils.R
-\name{cran_version}
-\alias{cran_version}
-\title{Check CRAN for package version}
-\usage{
-cran_version(pkg_name, cran_url = "http://cran.r-project.org/package=")
-}
-\arguments{
-\item{pkg_name}{String. Package name as published on CRAN.}
-
-\item{cran_url}{String. First part of the cannonical form of a package website on CRAN.}
-}
-\value{
-The package's version as a \code{numeric_version}.
-}
-\description{
-Check CRAN for package version
-}
-\examples{
-cran_version("shiny")
-}
-\keyword{internal}
diff --git a/man/create_app.Rd b/man/create_app.Rd
index 3e6334f..4ea3cdd 100644
--- a/man/create_app.Rd
+++ b/man/create_app.Rd
@@ -7,8 +7,8 @@
create_app(app_name = "myapp", app_dir = getwd(),
dir_out = "RInno_installer", pkgs = c("jsonlite", "shiny",
"magrittr"), pkgs_path = "bin", repo = "https://cran.rstudio.com",
- remotes = "none", app_repo_url = "none", auth_user = "none",
- auth_pw = "none", auth_token = github_pat(),
+ remotes = "none", locals = NULL, app_repo_url = "none",
+ auth_user = "none", auth_pw = "none", auth_token = github_pat(),
user_browser = "electron", include_R = FALSE,
include_Pandoc = FALSE, include_Chrome = FALSE,
include_Rtools = FALSE, R_version = paste0(">=", R.version$major,
@@ -31,6 +31,8 @@ create_app(app_name = "myapp", app_dir = getwd(),
\item{remotes}{Character vector of GitHub repository addresses in the format \code{username/repo[/subdir][\@ref|#pull]} for GitHub package dependencies.}
+\item{locals}{Character vector of local package dependencies. Deprecated as of v1.0.0. Use \code{pkgs} instead.}
+
\item{app_repo_url}{Repository address for continuous installations in the format \code{"https://bitbucket.org/username/repo"} (\code{repo = app_name}). Only Bitbucket and GitHub repositories are supported.}
\item{auth_user}{Bitbucket username. It is recommended to create a read-only account for each app. Support for OAuth 2 and tokens is in the works.}
@@ -70,7 +72,7 @@ This function manages installation and app start up. To accept all defaults, jus
Creates the following files in \code{app_dir}:
\itemize{
\item Icons for installer and app, \emph{setup.ico} and \emph{default.ico} respectively.
- \item Files that manage app start up, \emph{utils/package_manager.R}, \emph{utils/ensure.R}, and \emph{utils/app.R}.
+ \item Files that manage app start up, \emph{utils/package_manager.R}, \emph{utils/ensure.R}, and \emph{utils/launch_app.R}.
\item First/last page of the installer, \emph{infobefore.txt} and \emph{infoafter.txt}.
\item Batch support files, \emph{utils/wsf/run.wsf}, \emph{utils/wsf/js/run.js}, \emph{utils/wsf/js/json2.js}, \emph{utils/wsf/js/JSON.minify.js}.
\item A configuration file, \emph{config.cfg}. See \code{\link{create_config}} for details.
diff --git a/man/create_config.Rd b/man/create_config.Rd
index 5f1cc4c..31d5e7e 100644
--- a/man/create_config.Rd
+++ b/man/create_config.Rd
@@ -8,8 +8,7 @@ create_config(app_name, app_dir = getwd(), pkgs = c("jsonlite",
"remotes", "magrittr"), pkgs_path = "library", remotes = "none",
repo = "https://cran.rstudio.com", error_log = "error.log",
app_repo_url = "none", auth_user = "none", auth_pw = "none",
- auth_token = "none", user_browser = "electron",
- ping_site = "www.ficonsulting.com")
+ auth_token = "none", user_browser = "electron")
}
\arguments{
\item{app_name}{The name of the app. It will be displayed throughout the installer's window titles, wizard pages, and dialog boxes. See \href{http://www.jrsoftware.org/ishelp/topic_setup_appname.htm}{[Setup]:AppName} for details. For continuous installations, \code{app_name} is used to check for an R package of the same name, and update it. The Continuous Installation vignette has more details.}
@@ -35,8 +34,6 @@ create_config(app_name, app_dir = getwd(), pkgs = c("jsonlite",
\item{auth_token}{To install from a private Github repo, generate a personal access token (PAT) in \url{https://github.com/settings/tokens} and supply to this argument. This is safer than using a password because you can easily delete a PAT without affecting any others.}
\item{user_browser}{Character for the default browser. Options include "chrome", "firefox", and "ie."}
-
-\item{ping_site}{URL of a site to ping to check internet connectivity. Defaults to "www.ficonsulting.com".}
}
\value{
A json file, \emph{config.cfg}, in \code{app_dir}/utils.
diff --git a/man/grapes-greater-than-grapes.Rd b/man/grapes-greater-than-grapes.Rd
index 6a31ef2..435f45e 100644
--- a/man/grapes-greater-than-grapes.Rd
+++ b/man/grapes-greater-than-grapes.Rd
@@ -15,5 +15,5 @@ lhs \%>\% rhs
magrittr Pipes
}
\seealso{
-\code{\link[magrittr]{\%>\%}}
+\code{\link[magrittr]{magrittr}}
}
diff --git a/man/nativefy_app.Rd b/man/nativefy_app.Rd
index eb3ada1..0efbf22 100644
--- a/man/nativefy_app.Rd
+++ b/man/nativefy_app.Rd
@@ -1,5 +1,5 @@
% Generated by roxygen2: do not edit by hand
-% Please edit documentation in R/nativefier_app.R
+% Please edit documentation in R/nativefy_app.R
\name{nativefy_app}
\alias{nativefy_app}
\title{Package app into electron with nativefier}
diff --git a/man/standardize_pkgs.Rd b/man/standardize_pkgs.Rd
index d8eabc5..248ea2f 100644
--- a/man/standardize_pkgs.Rd
+++ b/man/standardize_pkgs.Rd
@@ -4,15 +4,13 @@
\alias{standardize_pkgs}
\title{Standardize package dependencies}
\usage{
-standardize_pkgs(pkgs, check_version = FALSE, string = FALSE)
+standardize_pkgs(pkgs)
}
\arguments{
\item{pkgs}{Processes \code{pkgs}, and \code{pkgs}, arguments of \code{\link{create_config}} and \code{\link{create_app}}.}
-
-\item{check_version}{Boolean. If true, check to make sure the package version is not ahead of CRAN.}
}
\value{
-Package dependency list with version numbers and inequalities. Defaults to \code{paste0(">=", packageVersion(pkg))}.
+Package dependency list
}
\description{
Standardizes (named or not) character vectors of package dependencies and formats it for config.cfg.
diff --git a/tests/testthat/test-standardize_pkgs.R b/tests/testthat/test-standardize_pkgs.R
index 27f4e98..a234abc 100644
--- a/tests/testthat/test-standardize_pkgs.R
+++ b/tests/testthat/test-standardize_pkgs.R
@@ -5,14 +5,6 @@ test_that("Package dependencies are installed", {
expect_error(standardize_pkgs(c(test = ">1.0")))
})
-test_that("Logical operators are valid", {
- expect_error(standardize_pkgs(c(shiny = "=<1.0.5")))
-})
-
-test_that("Numeric version numbers are valid", {
- expect_error(standardize_pkgs(c(shiny = "haha you lose")))
-})
-
test_that("Packages are standardized consistently", {
pkgs1 <- standardize_pkgs(c("shiny", "rmarkdown", "jsonlite"))
pkgs2 <- standardize_pkgs(c("shiny", "rmarkdown", jsonlite = ">=1.5"))
diff --git a/vignettes/Introduction.Rmd b/vignettes/Introduction.Rmd
index 53bc855..b6929ef 100644
--- a/vignettes/Introduction.Rmd
+++ b/vignettes/Introduction.Rmd
@@ -118,7 +118,7 @@ create_app(
`create_app` passes its arguments to most of the other support functions in RInno. You can (and probably should) specify most things there and they will get passed on. Alternatively, you can provide instructions directly to those support functions like this:
```
-# Copy installation scripts (JavaScript, icons, infobefore.txt, package_manager.R, app.R)
+# Copy installation scripts (JavaScript, icons, infobefore.txt, package_manager.R, launch_app.R)
copy_installation(app_dir = "my/app/path")
# If your users need R installed: