allAtOnce

This function runs in sequence most of the work that is done with ProcessSpace. The individual functions can be run individually for more control. Before running this function you must run generateCrossSections to generate a transectObject.

allAtOnce(
  transectObject,
  outputFilename,
  detrendElevs = TRUE,
  returnObject = TRUE,
  doExportSpatial = FALSE,
  rasterPaletteLims = c(-2, 2),
  ...
)

Arguments

transectObject

Object created by the generateCrossSections function.

outputFilename

This is the name of the pdf file that is generated as well as the KMZ if spatial files are exported.

detrendElevs

Logical (TRUE). Calculated a detrended raster file. Can be computationally expensive, especially with long target stream lengths.

returnObject

Logical (FALSE). Whether or not to return an R object for additional analysis. If FALSE, NULL is returned.

doExportSpatial

Logical (FALSE). Whether or not to generate KML exports. If both this and returnObject are FALSE, a pdf map and cross section plot are exported and nothing else.

rasterPaletteLims

Argument passed to exportSpatials to help color raster output

...

Additonal arguments to be passed to addTopoLines, addCrossSectionElevations, buildXSectionPlot, or rasterPlotter. You will likely need to pass a directory path to the raster (rasterDir) as well as a path to the streams shapefile (streamsDir).

Value

Either a transectObject or NULL

Details

Superseded: processSpace does all of this (including the cross-section generation) in one call with explicit arguments, and is the recommended entry point.