panel_configuration-class: Panel Configuration Class for NG-CHM

panel_configuration-classR Documentation

Panel Configuration Class for NG-CHM

Description

This configuration appears in the panel_configuration key of the mapConfig.json file under keys:

  • panel_layout: The hierarchical structure of containers and panes. The panes_list slot is converted to this structure.

  • Individual pane configurations (e.g., pane1, pane2) containing pane-specific settings. The pane_types slot is converted to these individual pane configurations.

Slots

panes_list

A list containing pane objects and sizes information.

For example, this panes_list format:

         list(pane(id="pane1"),
              pane(id="pane2"),
              sizes = c(50, 50))
       

will produce a layout like this:

                   |
             pane1 | pane2
                   |
       

This panes_list format:

         list(pane(id="pane1"),
              list(pane(id="pane2"),
                   pane(id="pane3"),
                   sizes = c(50, 50)),
         sizes = c(100))
       

will produce a layout like this:

                        |  pane2
                 pane1  | -------
                        |  pane3
       
pane_types

A named list mapping pane IDs to their configurations. Each element must be a detailMap, summaryMap, or pluginPane object. For example, the default two-pane layout is a detailMap and a summaryMap:

         pane_types = list(
                pane1 = detailMap(id = "pane1"),
                pane2 = summaryMap(id = "pane2")
         )
       

For example, a three-pane layout with a detail map, a summary map, and a plugin pane:

         pane_types = list(
                pane1 = detailMap(id = "pane1"),
                pane2 = summaryMap(id = "pane2"),
                pane3 = pluginPane(id = "pane3",
                   pluginName = "2D ScatterPlot: UMAP (column)")
         )
       

See Also

  • detailMap for detail map configuration

  • summaryMap for summary map configuration

  • pluginPane for plugin pane configuration


MD-Anderson-Bioinformatics/NGCHM-R documentation built on June 9, 2025, 8:04 p.m.