Skip to contents

Create Reference Data Frame to Pair Characteristic Results For Use in Numeric Criteria Equations (UNDER ACTIVE DEVELOPMENT)

Source: R/CriteriaComparison.R
TADA_CreatePairRef.Rd

This function creates a data frame that shows all combinations of TADA.CharacteristicName, TADA.CharacteristicName, TADA.ResultMeasure.MeasureUnitCode, TADA.MethodSpeciationName, and TADA.ResultSampleFractionText for commonly paired characteristics (such as pH, temperature, hardness, salinity, and chloride).

Usage

TADA_CreatePairRef(
  .data,
  ph = TRUE,
  hardness = TRUE,
  temp = TRUE,
  chloride = TRUE,
  salinity = TRUE,
  other_char = "null"
)

Arguments

.data

TADA dataframe

ph

Boolean argument. When ph = TRUE, pH is included in this reference data frame. When ph = FALSE, pH is not included in the reference data frame.

hardness

Boolean argument. When hardness = TRUE, hardness is included in this reference data frame. When hardness = FALSE, hardness is not included in the reference data frame.

temp

Boolean argument. When temp = TRUE, water temperature is included in this reference data frame. When temp = FALSE, water temperature is not included in the reference data frame.

chloride

Boolean argument. When chloride = TRUE, salinity is included in this reference data frame. When chloride = FALSE, chloride is not included in the reference data frame.

salinity

Boolean argument. When salinity = TRUE, salinity is included in this reference data frame. When salinity = FALSE, salinity is not included in the reference data frame.

other_char

Character argument. The user provides a data frame TADA.CharacteristicNames and the pairing group they belong to. #Needs more details.

Value

A data frame with six columns, TADA.CharacteristicName, TADA.ResultMeasure.MeasureUnitCode, TADA.MethodSpeciationName, TADA.ResultSampleFractionText, TADA.PairingGroup, and TADA.PairingGroupRank.

Examples

# create ref for hardness for example tribal data
HardnessRef <- TADA_CreatePairRef(Data_6Tribes_5y_Harmonized,
  ph = FALSE, hardness = TRUE,
  temp = FALSE, chloride = FALSE, salinity = FALSE, other_char = "null"
)