find_optical_depth: Depth of optical depth

View source: R/find_optical_depth.R

find_optical_depthR Documentation

Depth of optical depth

Description

Function to estimate the depth of a user-specified optical depth.

Usage

find_optical_depth(
  x,
  od.col = "optical_depth",
  depth.col = "cdepth",
  target.od = 2.302585,
  with.input = F,
  return.col = F
)

Arguments

x

Data frame containing optical depth and bin depth for a single cast.

od.col

Name of the data frame column containing optical depth

depth.col

Name of the data frame column containing depths

target.od

Optical depth value of interest.

with.input

Logical. Should the input data frame be returned with the optical depth? By default, false.

return.col

Optional. Name of the column for output. Default = F.

Value

Returns either a numerical vector with the optical depth for the cast, or a data frame with the input data and the optical depth data for the cast. Optical depths exceeding the maximum depth of the cast are returned as an NA.

Author(s)

Sean Rohan sean.rohan@noaa.gov


sean-rohan/trawllight documentation built on Jan. 13, 2023, 10:43 p.m.