_pkgdown.yml

url: https://r-spatialecology.github.io/landscapemetrics/

template:
  bootstrap: 5
  bootswatch: sandstone

reference:
  - title: Internal Datasets
    contents:
      - lsm_abbreviations_names
      - landscape
      - augusta_nlcd
      - podlasie_ccilc

  - title: Options for landscapemetrics
    contents:
      - options_landscapemetrics

  - title: Auxiliary/Utility functions
    contents:
      - calculate_correlation
      - check_landscape
      - extract_lsm
      - get_adjacencies
      - get_boundaries
      - get_centroids
      - get_circumscribingcircle
      - get_nearestneighbour
      - get_patches
      - get_unique_values
      - landscape_as_list
      - list_lsm
      - sample_lsm
      - scale_sample
      - spatialize_lsm
      - window_lsm

  - title: Visualisation functions
    contents:
      - show_patches
      - show_cores
      - show_correlation
      - show_lsm

  - title: Patch Level Metrics
    contents:
      - starts_with("lsm_p_")

  - title: Class Level Metrics
    contents:
      - starts_with("lsm_c_")

  - title: Landscape Level Metrics
    contents:
      - starts_with("lsm_l_")

  - title: Wrapper around all metrics
    contents:
      - calculate_lsm

navbar:
  structure:
    left:  [getstarted, reference, articles, news]
    right: [github, contact, search]
  components:
    getstarted:
      text: "Get Started"
      icon: fa fa-magic
      href: articles/get_started.html

    reference:
      icon: fa-gears
      text: "Functions"
      href: reference/index.html

    articles:
      icon: fa-graduation-cap
      text: "More"
      menu:
       - text: "General Background"
         icon: fa-book
         href: articles/general_background.html
       - text: "Differences FRAGSTATS|landscapemetrics"
         icon: fa-book
         href: articles/comparing_tools.html
       - text: "Landscape distribution statistics"
         icon: fa-book
         href: articles/landscape_distribution_statistics.html
       - text: "New Metrics outside FRAGSTATS"
         icon: fa-book
         href: articles/new_metrics.html
       - text: "Sample metrics"
         icon: fa-book
         href: articles/guide_sample_lsm.html
       - text: "Moving window"
         icon: fa-book
         href: articles/guide_moving_window.html
       - text: "Calculating landscape metrics for irregular areas"
         icon: fa-book
         href: articles/irregular_areas.html
       - text: "Utility functions"
         icon: fa-book
         href: articles/utility.html
       - text: "Publication Record"
         icon: fa-file-text-o
         href: articles/publication_record.html

    news:
      icon: fa-newspaper-o
      text: "News"
      href: news/index.html

    contact:
      icon: fa-user
      hreft: https://www.maxhesselbarth.com/

home:
  sidebar:
    structure: [authors, license, community]