Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: Adds fixes needed to publish to CRAN #13

Merged
merged 1 commit into from
Jan 11, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion DESCRIPTION
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
Package: tapLock
Title: Seamless SSO for R applications
Title: Seamless SSO for R Applications
Version: 0.1.0
Authors@R:
c(person(given = "ixpantia, SRL",
Expand Down
1 change: 1 addition & 0 deletions NAMESPACE
Original file line number Diff line number Diff line change
Expand Up @@ -12,3 +12,4 @@ export(new_google_config)
export(new_openid_config)
export(sso_shiny_app)
export(token)
export(use_futures)
16 changes: 16 additions & 0 deletions R/futures.R
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@

#' @title Use futures for asynchronous computations
#' @description Enable a future plan for asynchronous computations.
#' Since tapLock needs to do calls to external APIs, it can be a good idea
#' to use future to make the calls asynchronous.
#'
#' This function is just meant as a convenience function for the user.
#' We recommend that you read the documentation for the future package
#' to understand how to use it.
#' @param plan A plan object. Defaults to a multicore plan.
#' @param workers Number of workers to use. Defaults to 1.
#' @return This function is called for its side effect.
#' @export
use_futures <- function(plan = future::multicore, workers = 1) {
future::plan(plan, workers = workers)
}
25 changes: 25 additions & 0 deletions man/use_futures.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion vignettes/en_securing_shiny_google.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -99,7 +99,7 @@ sso_shiny_app(auth_config, ui, server)

Deploy your Shiny application as you normally would. The tapLock package handles the authentication process.
We recommend deploying your application with a solution like Shiny Server
(Open Source or Pro) or with [Faucet](https://github.com/andyquinterom/faucet).
(Open Source or Pro) or with [faucet](https://github.com/ixpantia/faucet).
Solutions like Posit Connect already include authentication and do not require
tapLock.

Expand Down
2 changes: 1 addition & 1 deletion vignettes/es_asegura_shiny_con_google.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -99,7 +99,7 @@ sso_shiny_app(auth_config, ui, server)

Despliega tu aplicación Shiny como lo harías normalmente. El paquete tapLock maneja el proceso de autenticación.
Recomendamos desplegar tu aplicación con una solución como Shiny Server
(Open Source o Pro) o con [Faucet](https://github.com/andyquinterom/faucet).
(Open Source o Pro) o con [faucet](https://github.com/ixpantia/faucet).
Soluciones como Posit Connect ya incluyen autenticación y no requieren
tapLock.

Expand Down