VisualizeMapOutput: Shiny App for visualizing HYPE MapOutputs.

View source: R/function_VisualizeMapOutput.R

VisualizeMapOutputR Documentation

Shiny App for visualizing HYPE MapOutputs.

Description

Interactive maps and plots for visualizing MapOutput files.

Usage

VisualizeMapOutput(
  results.dir = NULL,
  file.pattern = "^map.*\\.(txt|csv)$",
  map = NULL,
  map.subid.column = 1,
  output.dir = NULL
)

VisualiseMapOutput(
  results.dir = NULL,
  file.pattern = "^map.*\\.(txt|csv)$",
  map = NULL,
  map.subid.column = 1,
  output.dir = NULL
)

Arguments

results.dir

Optional string, path to a directory containing MapOutput files that should be loaded on app initialization.

file.pattern

Optional string, filename pattern to select files in results.dir that should be loaded on app initialization. See list.files.

map

Optional string, path to GIS file for subbasin polygons that should be loaded on app initialization. Typically a GeoPackage (.gpkg) or Shapefile (.shp).

map.subid.column

Optional integer, column index in the map 'data' slot holding SUBIDs (sub-catchment IDs) that should be used on app initialization.

output.dir

Optional string, path to a default output directory to save captured map images.

Details

VisualizeMapOutput is a Shiny app that provides interactive maps, plots, and tables for visualizing HYPE MapOutput files. The interactive Leaflet map is generated using PlotMapOutput. The app can be launched with or without the input arguments. All necessary input buttons and menus are provided within the app interface. For convenience, however, the input arguments can be provided in order to quickly launch the app with desired settings.

Value

VisualizeMapOutput returns a Shiny application object.

See Also

ReadMapOutput; PlotMapOutput

Examples

## Not run: 
if (interactive()) {
  VisualizeMapOutput(
    results.dir = system.file("demo_model", "results", package = "HYPEtools"),
    map = system.file("demo_model", "gis", "Nytorp_map.gpkg", package = "HYPEtools"),
    map.subid.column = 25
  )
}

## End(Not run)


rcapell/RHYPE documentation built on Feb. 28, 2024, 3:11 p.m.