_pkgdown.yml

reference:
  - title: Application
    desc: >
      Main functions and documentation for the application.
    contents:
      - wheretowork
      - run_app
      - get_golem_config

  - title: Sidebar panes
    desc: >
      Functions for sidebar panes.
    contents:
      - mapManagerSidebarPane
      - newSolutionSidebarPane
      - solutionResultsSidebarPane
      - exportSidebarPane
      - contactSidebarPane
      - acknowledgmentsSidebarPane

  - title: Import settings widget
    desc: >
      Functions for creating and updating the widget.
    contents:
      - importSettings
      - importSettings-shiny
      - updateImportSettings
      - cleanImportSettings

  - title: Solution settings widget
    desc: >
      Functions for creating and updating the widget.
    contents:
      - solutionSettings
      - updateSolutionSettings
      - solutionSettings-shiny

  - title: Map manager widget
    desc: >
      Functions for creating and updating the widget.
    contents:
      - mapManager
      - mapManager-shiny
      - addMapManagerLayer
      - dropMapManagerLayer
      - updateMapManagerOrder
      - updateMapManagerLayer

  - title: Solution results widget
    desc: >
      Functions for creating and updating the widget.
    contents:
      - solutionResults
      - solutionResults-shiny
      - addSolutionResults
      - dropSolutionResults
      - showSolutionResults

  - title: User interface elements
    desc: >
      Functions for creating user interface elements.
    contents:
      - leaflet_map
      - importModal
      - helpModal
      - solutionResultsModal
      - horizontalPickerInput

  - title: Simulate data
    desc: >
      Functions for simulating data.
    contents:
      - starts_with("simulate_")

  - title: Class constructors
    desc: >
      Functions for generating new objects.
    contents:
      - starts_with("new_")

  - title: Class definitions
    desc: >
      Definititions for classes used to organize data.
    contents:
      - Result
      - ContinuousLegend
      - CategoricalLegend
      - ManualLegend
      - NullLegend
      - Parameter
      - Statistic
      - Dataset
      - Provenance
      - Variable
      - Feature
      - Weight
      - Include
      - Exclude
      - Theme
      - Solution
      - SolutionSettings
      - MapManager
      - FeatureResults
      - WeightResults
      - IncludeResults
      - ExcludeResults
      - ThemeResults

  - title: Result functions
    desc: >
      Functions used to generate results.
    contents:
      - min_set_result
      - min_shortfall_result

  - title: Project functions
    desc: >
      Functions used to work with projects.
    contents:
      - read_project
      - write_project
      - find_projects

  - title: Validation functions
    desc: >
      Functions used to validate files.
    contents:
      - is_valid_attribute_file
      - is_valid_boundary_file
      - is_valid_spatial_file
      - is_valid_configuration_file

  - title: Shiny functions
    desc: >
      Functions used to interact with the front-end of the application.
    contents:
      - enable_html_element
      - disable_html_element
      - disable_html_css_selector
      - enable_html_css_selector
      - change_file_icon_js
      - removeMapPane

  - title: Spatial functions
    desc: >
      Functions for manipulating spatial data.
    contents:
      - spatial_data_type
      - spatial_data_statistics
      - readNamedRaster
      - writeNamedRaster
      - read_spatial_data
      - write_spatial_data
      - repair_spatial_data
      - shapefile_field_names
      - reserve_sizes
      - calculate_coverage

  - title: Miscellaneous functions
    contents:
      - color_palette
      - error_message
      - error_log
      - extract_data_matrix
      - prepare_fileInput
      - import_data
      - acknowledge_packages
      - write_excel_workbook