channel_correlation: Correlation between two channels (R workflow)

View source: R/alignment_functions.R

channel_correlationR Documentation

Correlation between two channels (R workflow)

Description

Calculate correlation coefficient between two channels (e.g. temperature and conductivity)

Usage

channel_correlation(
  x,
  exclude_flag = TRUE,
  c1 = "temperature",
  c2 = "conductivity",
  min_pressure = 4,
  cor_method = "pearson"
)

Arguments

x

oce object

exclude_flag

Logical denoting whether bad scans (flag < 0) should be excluded.

c1

Name of first channel as a character vector. Default = "temperature"

c2

Name of second channel as a character vector. Default = "conductivity"

min_pressure

Minimum pressure to use for correlations

cor_method

Correlation method to use as a character vector (see ?cor)

Value

Correlation coefficient (1L numeric)

Author(s)

Sean Rohan


afsc-gap-products/gapctd documentation built on March 5, 2025, 3:42 a.m.