checkSize_remeas: Check the size change of a remeasured subject

View source: R/checkSize_remeas.R

checkSize_remeasR Documentation

Check the size change of a remeasured subject

Description

This function is to check the size change for a remeasured subject.

Usage

checkSize_remeas(
  subjectID,
  measTime,
  size,
  change = "increase",
  maxChangeRate = NULL,
  toleranceMethod = "both",
  toleranceAbs = 0,
  toleranceRel = 0
)

Arguments

subjectID

character, Specifies subject ID, such as a tree id.

measTime

numeric, Measurement number with bigger value indicates a later measurement.

size

numeric, Measurement of an attribute.

change

character, Change direction either from increase or decrease. Default is increase.

maxChangeRate

numeric, It determines the maximum change rate. If the change rate from previous to current measurement exceeds the maximum change rate, then the pass of current measurement will be flagged as FALSE. If missing, this term is set as NULL.

toleranceMethod

character, Method to allow acceptable measurement error in an opposite direction of change argument. It must be either both (break both absolute and relative tolerance), either (break either absolute or relative tolerance), absolute (break absolute tolerance only), or relative (break relative tolerance only). Default is both.

toleranceAbs

numeric, Absolute tolerance value (exclusive) to allow measurement error. It must be a a non-negative value. If the change is increase, the change from current measurement to last measurement will be compared to the negative tolerance value, and vice versa. Default is 0 for zero tolerance.

toleranceRel

numeric, Relative tolerance value (exclusive) to allow measurement error. It must be a a non-negative value. If the change is increase, the change from current measurement to last measurement will be compared to the negative tolerance value, and vice versa. Default is 0 for zero tolerance.

Value

A data table that contains pass information. TRUE indicates pass, while FALSE indicates failure.

Author(s)

Yong Luo


bcgov/FAIBBase documentation built on June 19, 2024, 11:57 p.m.