_pkgdown.yml

url: https://r-tmap.github.io/tmap/
template:
  bootstrap: 5
  bslib:
    primary: "#5f8640"

# figures:
  dev: ragg::agg_png
  dpi: 300

development:
  version_tooltip: "tmap v4 documentation"

reference:

- title: Thematic Maps
  contents:
  - tmap-package
- title: Create a quick plot
  contents:
  - qtm
- title: Stacking tmap elements
  contents:
  - tmap-element
- title: Specify spatial data
  contents:
  - tm_shape
  - tm_crs
- title: Add data-driven map layers
  contents:
  - tm_polygons
  - tm_lines
  - tm_markers
  - tm_raster
  - tm_text
  - tm_iso
  - tm_sf
- title: Specify facets and animations
  contents:
  - tm_facets
  - tm_animate
- title: Add auxiliary map layers
  contents:
  - tm_tiles
  - tm_basemap
  - tm_rgb
  - tm_grid
  - tm_graticules
- title: Add map components
  contents:
  - tm_title
  - tm_credits
  - tm_compass
  - tm_scalebar
  - tm_logo
  - tm_minimap
  - tm_mouse_coordinates
  - tm_xlab
  - tm_inset
- title: Set scale for a visual variable
  desc: Always use those in this form `<vv>.scale = tm_scale*()`
  contents:
  - tm_scale
  - starts_with("tm_scale_")
  - -tm_scale_bar
- title: Set legend for a visual variable
  desc: Always use those in this form `<vv>.legend = tm_legend*()`
  contents:
  - starts_with("tm_legend")
  - tm_add_legend
  - tm_place_legends_right
- title: Set charts for a visual variable
  desc: Always use those in this form `<vv>.chart = tm_chart*()`
  contents:
  - starts_with("tm_chart")
- title: Configure legend and component position
  contents:
  - tm_pos
  - tm_components
- title: Set layout options
  contents:
  - tm_layout
  - tm_options
  - tm_view
  - tm_group
  - tm_plot
- title: Set options globally for tmap
  contents:
  - tmap_options
  - tmap_style
  - tmap_style_catalogue
  - tmap_mode
  - tmap_devel_mode
  - tmap_design_mode
- title: Export a tmap object
  contents:
  - tmap_save
  - tmap_leaflet
- title: Datasets included in tmap
  contents:
  - World
  - World_rivers
  - land
  - metro
  - starts_with("NLD")
- title: Use tmap in shiny
  contents:
  - renderTmap
- title: Print a tmap object
  contents:
  - tmap_last
  - print.tmap
  - tmap_animation
  - tmap_arrange
- title: Helper functions
  contents:
  - tm_const
  - tm_seq
  - tm_vars
  - tm_label_format
  - tm_plot_order
  - theme_ps
  - tmap_tip
  - tmap_icons
  - tmap_providers
  - tmap_overview

navbar:
  structure:
    left:  [reference, basics, foundations, example, comparison, extensions, advanced, news]
  components:
    home: ~
    basics:
      text: Basics
      menu:
        - text: Visual variables
          href: articles/basics_vv
        - text: Scales
          href: articles/basics_scales
        - text: Modes
          href: articles/basics_modes
        - text: Facets
          href: articles/basics_facets
        - text: Legends
          href: articles/basics_legends
        - text: Basemaps
          href: articles/basics_basemaps
        - text: Components
          href: articles/basics_components
        - text: Charts
          href: articles/basics_charts
        - text: Layout
          href: articles/basics_layout
        - text: Exporting
          href: articles/basics_exporting

    foundations:
      text: Foundations
      menu:
        - text: Grammar of Graphics
          href: articles/foundations_gg
        - text: Map projections (CRS)
          href: articles/foundations_crs

    example:
      text: Examples
      menu:
        - text: Choropleth (World)
          href: articles/examples_choro_World
        - text: Choropleth (Netherlands)
          href: articles/examples_choro_NLD
        - text: Bubble map
          href: articles/examples_bubble
        - text: Raster map
          href: articles/examples_raster
        - text: Topographic map (Africa)
          href: articles/examples_topo_Africa
        - text: Terrain map
          href: articles/examples_terrain
        - text: Gridmap
          href: articles/examples_gridmaps
        - text: Bivariate choropleth
          href: articles/examples_biv_choro

    comparison:
      text: Comparison
      menu:
        - text: tmap vs ggplot2
          href: articles/versus_ggplot2
        - text: tmap vs mapview
          href: articles/versus_mapview
        - text: tmap vs mapsf
          href: articles/versus_mapsf

    extensions:
      text: Extensions
      menu:
        - text: tmap.mapgl
          href: articles/ext_mapgl
        - text: tmap.cartogram
          href: articles/ext_cartogram
        - text: tmap.glyphs
          href: articles/ext_glyphs
        - text: tmap.networks
          href: articles/ext_networks

    advanced:
      text: Advanced
      menu:
        - text: Legends
          href: articles/adv_legends
        - text: Inset maps
          href: articles/adv_inset_maps
        - text: Animations
          href: articles/adv_animations
        - text: shiny integration
          href: articles/adv_shiny
        - text: ggplot2 integration
          href: articles/adv_ggplot2
        - text: Multivariate visual variables
          href: articles/adv_multivariate
        - text: Positioning of components
          href: articles/adv_positions
        - text: Grouping of components
          href: articles/adv_comp_group
        - text: Options and styles
          href: articles/adv_options
        - text: Margins and aspect ratio (plot mode)
          href: articles/adv_margins
        - text: Layer groups (view mode)
          href: articles/adv_groups
        - text: Extending tmap
          href: articles/adv_extensions