_pkgdown.yml

url: https://lynker-spatial.github.io/hfutils

development:
  mode: auto

home:
  title: hfutils — core utilities for the hydrofabric stack
  description: >
    Base-layer access, cleaning, network/topology, versioning, and quality
    checks for the Lynker Spatial hydrofabric.

authors:
  Mike Johnson:
    href: https://github.com/mikejohnson51
  Justin Singh-Mohudpur:
    href: https://github.com/program--
  footer:
    roles: [aut, cre]
    text: "Developed by"

template:
  bootstrap: 5
  bslib:
    primary: "#1EB5FF"
    secondary: "#1E39B7"
    info: "#66CCFF"
    bg: "#ffffff"
    fg: "#1f3347"
    base_font: { google: "Inter" }
    heading_font: { google: "Inter" }
    code_font: { google: "JetBrains Mono" }
    headings-font-weight: 600
    link-color: "#1E89FF"
    link-hover-color: "#1E39B7"
    code-color: "#1E39B7"
    border-radius: "0.5rem"
    navbar-light-bg: "#f7fbff"
    navbar-light-hover-color: "#1EB5FF"
  includes:
    in_header: |
      <meta name="theme-color" content="#1EB5FF">

navbar:
  bg: light
  structure:
    left:  [articles, reference]
    right: [stack, lynker, github]
  components:
    stack:
      text: Stack
      menu:
        - text: "Architecture overview"
          href: https://lynker-spatial.github.io/hfpublish/articles/architecture.html
        - text: -------
        - text: "hfsubset — subset"
          href: https://lynker-spatial.github.io/hfsubset
        - text: "hydrofabric — build"
          href: https://lynker-spatial.github.io/hydrofabric
        - text: "hfpublish — publish"
          href: https://lynker-spatial.github.io/hfpublish
    lynker:
      text: Lynker Spatial
      href: https://www.lynker-spatial.com/

footer:
  structure:
    left: developed_by
    right: lynker
  components:
    lynker: "The base layer of the [Lynker Spatial](https://www.lynker-spatial.com/) hydrofabric stack"

reference:
- title: Hydrofabric I/O
  desc: >
    Read and write hydrofabric layers from GeoPackages, and lazily query any
    GDAL/OGR vector source with dplyr.
  contents:
  - read_hydrofabric
  - write_hydrofabric
  - as_ogr
  - layer_exists
  - OGRSQL

- title: Cloud & GeoParquet
  desc: >
    Authenticated cloud access and GeoParquet/Arrow round-trips for sf objects.
  contents:
  - lynker_spatial_auth
  - lynker_spatial_token
  - lynker_spatial_refresh
  - duckdb_connection
  - tbl_http
  - st_read_parquet
  - st_write_parquet
  - read_sf_dataset
  - write_sf_dataset

- title: Geometry cleaning
  desc: >
    Repair and simplify DEM-derived catchment geometry, and fast unions by ID.
  contents:
  - clean_geometry
  - clean_gpkg_layer
  - union_polygons
  - union_linestrings
  - flowpaths_to_linestrings

- title: Network & topology
  desc: >
    Algorithms over the directed (DAG) flow network.
  contents:
  - accumulate_downstream
  - get_hydroseq
  - get_streamorder
  - add_measures
  - add_areasqkm
  - add_lengthkm
  - get_node
  - node_geometry
  - rename_geometry

- title: Versioning & quality assurance
  desc: >
    Stamp dataset versions and provenance into GeoPackages, and run staged
    pipeline invariant checks shared across the stack.
  contents:
  - gpkg_set_version
  - gpkg_get_version
  - hf_check_invariants
  - hf_check_merge_invariants
  - hf_check_attr_bounds
  - hf_attr_bounds

- title: DBI / OGR-SQL backend
  desc: >
    Low-level S4 classes and methods backing the lazy `as_ogr()` interface.
  contents:
  - st_as_sf
  - "OGRSQLConnection-class"
  - "OGRSQLDriver-class"
  - "OGRSQLResult-class"
  - "dbConnect,OGRSQLDriver-method"

- title: internal
  desc: Internal helpers (documented for completeness).
  contents:
  - has_keyword("internal")