_pkgdown.yml

url: https://nhs-south-central-and-west.github.io/scwplot/
template:
  bootstrap: 5

navbar:
  structure:
    right: [github]
  components:
    github:
      icon: fa-github
      href: https://github.com/NHS-South-Central-and-West/scwplot
      aria-label: GitHub

reference:
  - title: Plot Basics
    contents:
      - finalise_plot
  - title: Theme
    desc: >
      Style ggplot figures using an SCW theme.
    contents:
      - starts_with("theme")
  - title: Colour Scales
    desc: >
      Distinguish how colour is used to represent data values visually. Use
      `scale_*_sequential()` to encode numerical information that has a
      natural order (where data can be ordered from high to low, or vice versa),
      `scale_*_diverging()` to encode numerical information that is ordered and
      has a meaningful midpoint (for example, scales in a survey), and
      `scale_*_qualitative()` to encode categories that have no natural order.
    contents:
      - starts_with("scale")
  - title: Colour Palettes
    contents:
      - starts_with("pal")
  - title: Plot Images
    desc: >
      Incorporate images into plot figures.
    contents:
      - ends_with("images")
  - title: Format Labels
    contents:
      - add_commas