check_TranspirationRegions: Check transpiration regions

View source: R/sw_Vegetation.R

check_TranspirationRegionsR Documentation

Check transpiration regions

Description

The transpiration regions are checked:

  1. There is least one transpiration region

  2. All transpiration regions include at least one soil layer

  3. Transpiration regions are strictly increasing

  4. Transpiration regions go no deeper than the most shallow rooting profile of any active vegetation type

Usage

check_TranspirationRegions(swInputData)

Arguments

swInputData

A rSOILWAT2 input object of class swInputData.

Value

A logical value.

Examples

sw_in <- rSOILWAT2::sw_exampleData
check_TranspirationRegions(sw_in) ## Expected: TRUE

# Make a mistake: set a transpiration region deeper than the rooting profile
swSite_TranspirationRegions(sw_in)[2, 2] <- 10
check_TranspirationRegions(sw_in) ## Expected: FALSE


Burke-Lauenroth-Lab/Rsoilwat documentation built on Dec. 9, 2023, 12:41 a.m.