station_to_distance: Convert Stations To Distance

In mkoohafkan/RAStestR: Functions for testing RAS outputs

Description

Convert station values to distance upstream.

Usage

station_to_distance(d, distance.col = "Distance", station.col = "Station",
  direction = c("downstream", "upstream"), metric = FALSE)

Arguments

d	The long-format data, i.e. output from to_longtable.
distance.col	The new column to hold distance values.
station.col	The column containing station values.
direction	Compute distance upstream or downstream.
metric	If TRUE, stations are assumed to be in kilometers and distances are returned in meters. If FALSE, stations are assumed to be in miles and distances are returned in feet.

Value

The data table with an additional column of distances.

Examples

simple.quasi = system.file("sample-data/SampleQuasiUnsteady.hdf",
  package = "RAStestR")
quasi.flow = read_standard(simple.quasi, "Flow")
long.flow = to_longtable(quasi.flow, "Flow")
station_to_distance(long.flow)
station_to_distance(long.flow, metric = TRUE)
station_to_distance(long.flow, "Distance Upstream",
  direction = "upstream")

mkoohafkan/RAStestR documentation built on July 14, 2019, 11:41 p.m.