diff --git a/NAMESPACE b/NAMESPACE index 91b4f9a..8ffc38f 100644 --- a/NAMESPACE +++ b/NAMESPACE @@ -14,4 +14,3 @@ export(new_entra_id_config) export(new_google_config) export(new_openid_config) export(token) -export(use_futures) diff --git a/R/futures.R b/R/futures.R deleted file mode 100644 index ebabf40..0000000 --- a/R/futures.R +++ /dev/null @@ -1,15 +0,0 @@ -#' @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) -} diff --git a/README.md b/README.md index 90c574c..60ac9a7 100644 --- a/README.md +++ b/README.md @@ -45,7 +45,7 @@ auth_config <- new_openid_config( ### 2. Secure your Shiny application To secure your Shiny Application you will need to add the middleware layers -using [tower]("https://github.com/ixpantia/tower") and configure the +using [tower](https://github.com/ixpantia/tower) and configure the client credentials. Here is an example of a Shiny application that uses tapLock to secure diff --git a/man/use_futures.Rd b/man/use_futures.Rd deleted file mode 100644 index 0c123d9..0000000 --- a/man/use_futures.Rd +++ /dev/null @@ -1,25 +0,0 @@ -% Generated by roxygen2: do not edit by hand -% Please edit documentation in R/futures.R -\name{use_futures} -\alias{use_futures} -\title{Use futures for asynchronous computations} -\usage{ -use_futures(plan = future::multicore, workers = 1) -} -\arguments{ -\item{plan}{A plan object. Defaults to a multicore plan.} - -\item{workers}{Number of workers to use. Defaults to 1.} -} -\value{ -This function is called for its side effect. -} -\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. -}