RSurvey (version 0.4.5)

tran.dat: Set or Query Transect Data

Description

This function is used to set or query transect data.

Usage

tran.dat(id, option, value, clearId = FALSE, clearAll = FALSE)

Arguments

id

the transect name.

option

the parameter name, see Transect Parameters section.

value

a parameter value specified for option.

clearId

a logical; if TRUE all data associated with transect id is cleared.

clearAll

a logical; if TRUE all components are cleared from tran.dat.

Transect Parameters

lll{ asp.ratio numeric the local z/x aspect ratio. data.file character the file name associated with the raster data. data.ras data.frame rows corresponding to raster point records and columns to the raster fields. fix.zero character "R" for establishing the right vertex as the origin and "L" for the left. grid.dx numeric the spatial resolution of the raster interpolation grid along the local x-axis. grid.dy numeric the spatial resolution of the raster interpolation grid along the local z-axis. h.offset numeric the local x-axis offset measured from the vertex origin. id character the name of the transect. limits data.frame rows corresponding to the raster types and columns to the raster plotting limits. prof data.frame rows corresponding to points along the transect and columns to local x and z values. type character fields within the imported raster data, a concatenation of column type and units. v.offset numeric the local z-axis offset, positive upward. v.origin numeric the z value corresponding to the local z-axis origin. vel.vect character fields corresponding to velocity vector components: x, y, z, and principle direction. vertices matrix rows corresponding to the transect vertices and columns to x and y values. hv.fields character raster fields corresponding to the local-x and local-z directions. }

Examples

# To set a parameter within a transect
tran.dat("T1", "h.offset", 10)
tran.dat("T1", "v.origin", 3.14)
tran.dat("T2", "h.offset", 9)
# To get a parameter value
tran.dat("T1", "h.offset")
# To get all transect data
tran.dat()
# To get transect data for T1
tran.dat("T1")
# To clear all data associated with a transect
tran.dat("T1", clearId = TRUE)
# To clear all transect data
tran.dat(clearAll = TRUE)