prepare_display: Set up all auxiliary files needed for a Trelliscope app

View source: R/json_writers.R

prepare_displayR Documentation

Set up all auxiliary files needed for a Trelliscope app

Description

Set up all auxiliary files needed for a Trelliscope app

Usage

prepare_display(
  base_path,
  id,
  self_contained = FALSE,
  jsonp = TRUE,
  require_token = FALSE,
  disclaimer = FALSE,
  pb = NULL
)

Arguments

base_path

the base directory of the trelliscope application

id

a unique id for the application

self_contained

should the Trelliscope display be a self-contained html document?

jsonp

should json for display list and app config be jsonp (TRUE) or json (FALSE)?

require_token

require a special token for all displays to be visible (experimental)

disclaimer

an optional string of html to include as a disclaimer for the set of displays

pb

optional progress bar object to pass in and use to report progress


trelliscopejs documentation built on Aug. 8, 2025, 6:40 p.m.