ch_wbt_filenames: Creates names for Whitebox function input and output files

In CSHShydRology: Canadian Hydrological Analyses

Creates names for Whitebox function input and output files

Description

Creates a list of the files used for inputs and outputs by the Whitebox functions. This function needs to be called before calling any of the other Whitebox (i.e. those prefixed by cd_wbt) functions. If the file names are not specified, default names will be used. All raster files are TIFF (.tif), all vector files are shapefiles (.shp).

Usage

ch_wbt_filenames(
  wd = NULL,
  fn_dem = "dem.tif",
  fn_dem_fsc = "dem_fsc.tif",
  fn_dem_ns = "dem_ns.tif",
  fn_flowacc = "flow_acc.tif",
  fn_flowdir = "flow_dir.tif",
  fn_channel_ras = "channel.tif",
  fn_channel_vec = "channel.shp",
  fn_catchment_ras = "catchment.tif",
  fn_catchment_vec = "catchment.shp",
  fn_pp = "pp.shp",
  fn_pp_snap = "pp_snap.shp"
)

Arguments

wd	Required. Name of working directory.
fn_dem	File name of input DEM. Default is dem.tif.
fn_dem_fsc	File name for dem after filling single-cell pits. Default is dem_fsc.tif.
fn_dem_ns	File name for dem removing sinks. Default is dem_ns.tif.
fn_flowacc	File name for DEM flow accumulation grid Default is flow_acc.tif.
fn_flowdir	File name for DEM flow direction grid. Default is flow_dir.tif.
fn_channel_ras	File name for raster version of channel network. Default is channel.tif.
fn_channel_vec	File name for vector version of channel networks. Default is channel.shp.
fn_catchment_ras	File name for raster version of catchment. Default is catchment.tif.
fn_catchment_vec	File name for vector version of catchment. Default is catchment.shp.
fn_pp	File name for pour points (input). Vector file. Default is pp.shp.
fn_pp_snap	File name for pour points after snapping to channel network. Vector file. Default is pp.shp.

Value

Returns a list of the input and output file names

Author(s)

Dan Moore

Examples

wbt_file_names <- ch_wbt_filenames(getwd())

CSHShydRology documentation built on Sept. 11, 2024, 5:50 p.m.