_pkgdown.yml

template:
  bootstrap: 5
  bootswatch: cerulean
  bslib:
    primary: "#003399"

reference:
- title: Basemap functions
  desc: >
    Maps are plotted using the `basemap()` or `qmap()` functions that work
    almost similarly to 
    [`ggplot()` as a base](https://ggplot2.tidyverse.org/reference/index.html)
    for adding further layers to the plot using the `+` operator. The maps 
    generated this way already contain multiple ggplot layers. 
    Consequently, the [`data` argument](https://ggplot2.tidyverse.org/reference/ggplot.html)
    needs to be explicitly specified inside `geom_*` functions when 
    adding `ggplot2` layers. Depending on the location of the map, the underlying
    coordinates may be projected. Decimal degree coordinates need to be transformed 
    to the projected coordinates using the `transform_coord`, 
    [ggspatial](https://paleolimbot.github.io/ggspatial/), or 
    [`geom_sf` functions.](https://ggplot2.tidyverse.org/reference/ggsf.html). The 
    `shapefile_list` function can be used to acquire `shapefiles` argument names 
    when limiting basemaps using projected coordinates.
  contents:
  - basemap
  - qmap
  - transform_coord
  - shapefile_list 
  - dist2land
  - get_depth

- title: Functions to help customizing basemaps
  desc: >
    These functions help in customizing basemaps. The `auto_limits` function can be used to 
    retrieve projected coordinates from decimal degree position data and the
    `reorder_layers` can be used to move land and glaciers on top of added 
    ggplot2 data layers.
  contents:
  - auto_limits
  - reorder_layers
  - theme_map
  
- title: Create bathymetries and shapefiles
  desc: >
    Custom bathymetry shapes can be added using the `raster_bathymetry` and 
    `vector_bathymetry` functions in this order. The underlying data can be 
    retrieved from the [ETOPO](https://www.ncei.noaa.gov/products/etopo-global-relief-model) or
    [GEBCO](https://www.gebco.net/data_and_products/gridded_bathymetry_data/)
    repositories. Already existing 
    [Geonorge](https://kartkatalog.geonorge.no/metadata/kartverket/dybdedata/2751aacf-5472-4850-a208-3532a51c529a)
    bathymetries can be opened and added to the `shapefiles` argument as 
    `list(bathy =)`. The `clip_shapefile` function can be used to crop already
    existing SpatialPolygons.
  contents:
  - raster_bathymetry
  - vector_bathymetry
  - geonorge_bathymetry
  - clip_shapefile
  - rotate_crs
  
- title: Size adjustment functions
  desc: >
    These functions convert line widths and font sizes measured in points (pt) 
    to ggplot2 equivalents. They can be used to follow line width and font size
    requirements set by journals. 
  contents: 
  - LS
  - FS

- reference:
- title: Map data
  desc: >
    Shape- and raster files used by the package. Higher resolution files are 
    stored in the [ggOceanMapsLargeData](https://github.com/MikkoVihtakari/ggOceanMapsLargeData)
    repository. These files are automatically used by the basemap function. The 
    `basemap` function also supports custom sf and stars objects. 
  contents:
  - dd_land
  - dd_rbathy

- reference:
- title: Datasets
  desc: >
    The package contains ICES and Norwegian Directorate of Fisheries areas as sf
    objects. These shapefiles are used in examples and included here for
    convenience because they are regularly needed by the package author. 
  contents:
  - ices_areas
  - fdir_main_areas
  - fdir_sub_areas

- title: Internal basemap functions
  desc: >
    Internal functions dealing with data and graphics for basemap. These 
    functions are run on the background and only needed if you modify your maps
    beyond the options offered by ggOceanMaps.
  contents:
  - basemap_data
  - define_shapefiles
  - guess_coordinate_columns
  - is_decimal_limit
  - map_cmd
  - round_any
  - quiet
  - dd_to_deg
  - deg_to_dd
  - select_element
  - dd_clip_boundary

navbar:
 components:
   intro:
    text: User manual
    href: articles/ggOceanMaps.html
   articles:
    text: Articles
    menu:
    - text: News
    - text: New features in version 2
      href: articles/new-features.html
    - text: -------
    - text: Customising shapefiles
    - text: Premade maps
     # href: articles/premade-maps.html
    - text: Premade shapefiles
    #  href: articles/premade-shapefiles.html
    - text: -------
    - text: Presentations
    - text: SI2022 poster
      href: articles/poster.html
    - text: AeN workshop slides
      href: https://aen-r-workshop.github.io/4-ggOceanMaps/ggOceanMaps_workshop.html