Build habitat eligibility rules YAML from dimensions CSV

Transforms a species habitat dimensions CSV into the rules YAML format consumed by fresh::frs_habitat(). The CSV is the human-edited source of truth; the YAML is the derived artifact.

Usage

lnk_rules_build(
  csv,
  to,
  thresholds = system.file("extdata", "parameters_habitat_thresholds.csv", package =
    "fresh"),
  edge_types = c("categories", "explicit")
)

Arguments

csv: Path to a dimensions CSV with columns: species, spawn_lake, spawn_stream, rear_lake, rear_lake_only, rear_no_fw, rear_stream, rear_wetland. Optional columns: river_skip_cw_min (yes/no — skip channel_width_min on river polygon segments), notes.
to: Path to write the output YAML.
thresholds: Path to the habitat thresholds CSV (from fresh). Used to look up rear_lake_ha_min per species. Default uses the copy shipped with fresh.
edge_types: Character. How to express stream edge types in rules: "categories" (default) uses fresh categories (stream, canal). "explicit" uses integer FWA edge_type codes (1000, 1100, 2000, 2300).

Value

Invisible path to the written YAML file.

Examples

if (FALSE) { # \dontrun{
# NGE defaults
lnk_rules_build(
  csv = system.file("extdata", "parameters_habitat_dimensions.csv", package = "link"),
  to = "inst/extdata/parameters_habitat_rules.yaml"
)

# bcfishpass comparison variant
lnk_rules_build(
  csv = system.file("extdata", "configs", "bcfishpass", "dimensions.csv",
                    package = "link"),
  to = "inst/extdata/configs/bcfishpass/rules.yaml",
  edge_types = "explicit"
)
} # }