rLakeAnalyzer (version 1.11.4.1)

ts.thermo.depth: Calculate physical indices for a timeseries.

Description

Functions for simplifying the calculation of physical indices for a timeseries of observation data. Can usually be called directly on data loaded directly using load.ts and load.bathy.

These are wrapper functions that accept a timeseries of data and call the core physical metric functions (like schmidt.stability) on each timestep.

Usage

ts.thermo.depth(wtr, Smin = 0.1, na.rm = FALSE, ...)

Arguments

wtr

A data frame of water temperatures (in Celsius). Loaded using load.ts. Must have columns datetime, wtr_##.# where ##.# is depth in meters.

Smin

The minimum density gradient cutoff (kg/m^3/m) defining the metalimion

na.rm

Boolean indicated if step-by-step removal of NA's should be tried. If false, a timestep with any NA values will return an NA value. If true, best effort will be made to calculate indices despite NA values.

...

Additional parameters passed to underlying base function (e.g., index=TRUE for thermo.depth)

Value

Returns a data frame with the timeseries of calculated derivatives. All include a ‘datetime’ column, but derivative columns differ between functions.

See Also

For loading input data load.ts, load.bathy.

For the underlying functions operating at each timestep meta.depths, thermo.depth, schmidt.stability, lake.number, internal.energy.

Other Timeseries functions for r Lake Analyzer: ts.internal.energy, ts.lake.number, ts.meta.depths, ts.schmidt.stability, ts.uStar

Examples

# NOT RUN {
	#Get the path for the package example file included
	exampleFilePath <- system.file('extdata', 'Sparkling.daily.wtr', package="rLakeAnalyzer")
	
	#Load
	sparkling.temp = load.ts(exampleFilePath)
  
  
  #calculate and plot the thermocline depth
	t.d = ts.thermo.depth(sparkling.temp)
	
	plot(t.d$datetime, t.d$thermo.depth, type='l', ylab='Thermocline Depth (m)', xlab='Date')
  
# }