dca_waiter: DCA Waiter

In Sage-Bionetworks/dcamodules: Data Curator App Modules

DCA Waiter

Description

This is wrapper function on the top of waiter for data curator app.

Usage

dca_waiter(
  stage = c("show", "update", "hide"),
  id = NULL,
  user.name = "DCA User",
  is.landing = FALSE,
  is.stop = FALSE,
  sleep = 2,
  is.certified = TRUE,
  is.permission = TRUE,
  msg = NULL,
  spin = NULL,
  color = NULL
)

Arguments

stage	Type of waiter, 'show' to initiate waiter screen, 'update' to update a waiter screen, or 'hide' to hide a waiter screen.
id	Id of element to hide or element on which to show waiter over.
user.name	Name of user.
is.landing	Whether the waiter screen is used for landing process, including landing page, login failed pages, and welcome page.
is.stop	Whether the waiter screen will be stopped after rendered.
sleep	Time to keep the loading screen before hiding - recommend to give at least 2s to let users view the page.
is.certified	Whether the user is synapse certified.
is.permission	Whether the user have sufficient permission to the fileview.
msg	Message displayed in the waiter screen.
spin	Spinner displayed in the waiter screen.
color	Background color of the waiter screen.

Value

show, update, or stop a waiter screen.

Examples

if (interactive()) {
  # check the waiter tab in the gallery
  dcamodules::showcase()
}

Sage-Bionetworks/dcamodules documentation built on Jan. 26, 2023, 1:15 a.m.