metric.values.coral: Calculate metric values, coral

View source: R/metric_values.R

metric.values.coralR Documentation

Calculate metric values, coral

Description

Subfunction of metric.values for use with coral

Usage

metric.values.coral(
  myDF,
  MetricNames = NULL,
  boo.Adjust = FALSE,
  cols2keep = NULL,
  MetricSort = NA,
  boo.Shiny = FALSE,
  verbose
)

Arguments

myDF

Data frame of taxa.

MetricNames

Optional vector of metric names to be returned.

boo.Adjust

Optional boolean value on whether to perform adjustments of values prior to scoring. Default = FALSE but may be TRUE for certain metrics.

cols2keep

Column names of fun.DF to retain in the output. Uses column names.

MetricSort

How metric names should be sort; NA = as is , AZ = alphabetical. Default = NULL.

boo.Shiny

Boolean value for if the function is accessed via Shiny. Default = FALSE.

verbose

Include messages to track progress. Default = FALSE

Details

For internal use only. Called from metric.values().

Value

Data frame


leppott/BioMonTools documentation built on March 1, 2025, 7:18 a.m.