calculateStratificationIndex: Calculate stratification index

View source: R/calculations.R

calculateStratificationIndexR Documentation

Calculate stratification index

Description

This function calculates the stratification index, which is defined as the difference in density between two defined depths divided by the difference in the two depths. The calculation completes two iterations. The first is between the two defined depths, and then if the calculated value is less than 0, the depth range is slightly increased.

Usage

calculateStratificationIndex(ctd, depth1, depth2, debug = TRUE)

Arguments

ctd

a ctd object.

depth1

a numeric value, such that depth1 < depth2

depth2

a numeric value, such that depth2 > depth1

debug

a logical value indicating if debug info should be displayed

Value

a single row data frame with relevant information for easy output use

Author(s)

Chantelle Layton and Benoit Casault


clayton33/csasMarPhys documentation built on June 8, 2025, 3:10 a.m.