_pkgdown.yml

url: https://frbcesab.github.io/forcis

template:
  bootstrap: 5
  bslib:
    primary: "#2b4370"

navbar:

  components:
  
    reference:
      text: Functions
      href: reference/index.html
      
    articles:
      text: Vignettes
      menu:
      - text: Sampling devices
        href: articles/sampling-devices.html
      - text: Database versions
        href: articles/database-versions.html
      - text: Select, reshape, and filter data
        href: articles/select-and-filter-data.html
      - text: Data conversion
        href: articles/data-conversion.html
      - text: Data visualization
        href: articles/data-visualization.html

reference:

- title: Database tools
  desc: >
    Functions to download and import FORCIS database
  contents:
    - download_forcis_db
    - read_cpr_north_data
    - read_cpr_south_data
    - read_plankton_nets_data
    - read_pump_data
    - read_sediment_trap_data

- title: Database versions
  desc: >
    Functions to get information on database versions
  contents:
    - get_available_versions
    - get_current_version
    - get_version_metadata

- title: Select and filters tools
  desc: >
    Function to select and filter FORCIS data
  contents:
    - select_forcis_columns
    - select_taxonomy
    - filter_by_species
    - filter_by_month
    - filter_by_year
    - filter_by_bbox
    - filter_by_ocean
    - filter_by_polygon

- title: Standardization functions
  desc: >
    Functions to homogenize, compute, and aggregate FORCIS data
  contents:
    - compute_abundances
    - compute_concentrations
    - compute_frequencies

- title: Visualization tools
  desc: >
    Functions to visualize FORCIS data
  contents:
    - geom_basemap
    - ggmap_data
    - plot_record_by_year
    - plot_record_by_month
    - plot_record_by_season
    - plot_record_by_depth

- title: Utilities
  desc: >
    Helper functions
  contents:
    - convert_to_long_format
    - data_to_sf
    - get_ocean_names
    - get_required_columns
    - get_species_names