Write a "display object" file for a Trelliscope app
write_display_obj( cogdf, panel_example, base_path, id, name, group = "common", desc = "", height = 500, width = 500, md_desc = "", state = NULL, jsonp = TRUE, split_sig = NULL, panel_img_col = NULL, self_contained = FALSE, thumb = TRUE, split_layout = FALSE, split_aspect = NULL, has_legend = FALSE, pb = NULL )
| cogdf | a data frame of cognostics, prepared with |
|---|---|
| panel_example | an example object of one panel of a display (can be trellis, ggplot2, or htmlwidget object) |
| base_path | the base directory of the trelliscope application |
| id | a unique id for the application |
| name | name of the display |
| group | group that the display belongs to |
| desc | description of the display |
| height | height in pixels of each panel |
| width | width in pixels of each panel |
| md_desc | optional string of markdown that will be shown in the viewer for additional context about the display |
| state | the initial state the display will open in |
| jsonp | should json for display object be jsonp (TRUE) or json (FALSE)? |
| split_sig | optional string "signature" specifying the data splitting |
| panel_img_col | which column (if any) is a panel image column? |
| self_contained | should the Trelliscope display be a self-contained html document? |
| thumb | should a thumbnail be created? |
| split_layout | boolean that determines if the layout is split into components like a facet_grid vs. individual panels like facet_wrap. Only applies to ggplot2 plot objects. |
| split_aspect | list indicating aspect ratios of axes for a split layout. Only applies to ggplot2 plot objects. |
| has_legend | should a legend be reported for split_layout |
| pb | optional progress bar object to pass in and use to report progress |