dash_app: Create a Dash application

Description Usage Arguments See Also

View source: R/wrappers.R

Description

This is a convenience function that returns a Dash R6 object. For advanced usage, you can use the object as an R6 object directly instead of the functions provided by the {dash} package.

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
dash_app(
  title = NULL,
  update_title = "Updating...",
  assets_folder = "assets",
  assets_url_path = "/assets",
  assets_ignore = NULL,
  eager_loading = FALSE,
  serve_locally = TRUE,
  pathname_url_base = "/",
  pathname_routes_prefix = NULL,
  pathname_requests_prefix = NULL,
  compress = TRUE,
  suppress_callback_exceptions = FALSE,
  show_undo_redo = FALSE
)

Arguments

title

(character) The browser window title.

update_title

(character) The browser window title while a callback is being processed. Set to NULL or "" if you don't want Dash to automatically update the window title.

assets_folder

(character) Path (relative to the current working directory) containing extra files to be served by the browser. All files with ".js" or ".css" extensions will automatically be included on the page, unless excluded with assets_ignore. Any other files, such as images, will only be served if explicitly requested.

assets_url_path

(character) URL path for serving assets. For example, a value of "www" means that any request path that begins with "/www" will be mapped to the assets_folder. If your assets are hosted online, you can provide a CDN URL, such as "http://your-assets-website".

assets_ignore

(character) Regular expression for ".js" and ".css" files that should not be automatically included. Ignored files will still be served if explicitly requested. Note that you cannot use this to prevent access to sensitive files since ignored files are accessible by users.

eager_loading

(logical) Whether asynchronous resources are prefetched (TRUE) or loaded on-demand (FALSE).

serve_locally

(logical) Whether to serve HTML dependencies locally or remotely (via URL).

pathname_url_base

(character) Local URL prefix to use app-wide.

pathname_routes_prefix

(character) Prefix applied to the backend routes. Defaults to pathname_url_base.

pathname_requests_prefix

(character) Prefix applied to request endpoints made by Dash's front-end. Defaults to pathname_url_base.

compress

(logical) Whether to try to compress files and data. If TRUE, then brotli compression is attempted first, then gzip, then the deflate algorithm, before falling back to identity.

suppress_callback_exceptions

(logical) Whether to relay warnings about possible layout mis-specifications when registering a callback.

show_undo_redo

(logical) If TRUE, the app will have undo and redo buttons for stepping through the history of the app state.

See Also

run_app()


dash documentation built on Nov. 7, 2021, 9:06 a.m.