_pkgdown.yml

url: https://yunuuuu.github.io/ggalign/

template:
  bootstrap: 5
  light-switch: true

reference:
- title: Layout
  desc: A `Layout` object defines how to place the plots.
  contents:
  - layout_heatmap
  - layout_stack

- title: Layout Building
  desc: >
    All plots begin with a call to `ggheatmap()` or `ggstack()`, supplying default 
    data. You then reorder the layout, or group the layout into panels, and add 
    plots, layers, scales, coords with `+`. Use `hmanno()` or `stack_active()` to 
    control the layout attributes. To save a plot to disk, use `ggsave()`.
  contents:
  - layout-add
  - hmanno
  - stack_active
  - layout-operator

- title: Layout Plot
  desc: >
    This section covers essential functions to add individual plots to the layout, 
    ensuring they align and interact correctly within the defined structure.
  contents:
  - ggalign
  - ggpanel

- title: Layout Customization
  desc: >
    Fine-tune the arrangement of plots by reordering or splitting axes into separate panels. 
    These functions allow for more detailed customization of plot layouts.
  contents:
  - align_dendro
  - align_group
  - align_kmeans
  - align_reorder

- title: Plot composer
  desc: >
    This section outlines essential functions for composing plots into a grid,
    intended for internal use. The core code is derived from the `patchwork`
    package, with the hope of eventually integrating and merging these functions
    into the `patchwork` project.
  contents:
  - align_plots
  - patch_titles
  - free_align
  - free_border
  - free_lab
  - free_space
  - area
  - inset
  - wrap

- title: Extending Plot Composer
  desc: >
    Extending capabilities to align graphics with `align_plots()`.
  contents:
  - alignpatch
  - patch

- title: helpers
  desc: A handful of helpers
  contents:
  - ggalignGrob
  - ggalign_stat
  - hclust2
  - dendrogram_data
  - is.ggheatmap
  - is.ggstack
  - geom_draw
  - read_example

- title: internal
  contents:
  - starts_with("patch.")

articles:
- title: Building plots
  navbar: ~
  contents:
  - layout-heatmap
  - align-layout
  - align-plot
  - layout-stack
  - scales-and-facets

- title: FAQ
  navbar: " "
  contents:
  - articles/FAQ

- title: ComplexHeatmap
  navbar: ComplexHeatmap
  contents:
  - articles/single-heatmap
  - articles/more-examples