VRICompiler: VRI compiler - VRI specific

Description Usage Arguments Value Author(s) References

View source: R/VRICompiler.R

Description

This function compiles VRI data by calling specific VRI functions. Unlike the original compiler (i.e., SAS compiler), the R version compiler hardcodes all the lookup tables in the compilation process. Please refer the descriptions for lookup table to see whether they are same as the original lookup table.

Usage

1
2
3
4
5
VRICompiler(dataSourcePath, outputPath = ".", equation = "KBEC",
  walkThru = TRUE, logMinLength = 0.1, stumpHeight = 0.3,
  breastHeight = 1.3, UTOPDIB = 10, utilLevel = 4, weirdUtil = "No",
  siteToolsDLLPath,
  sasExePath = "C:/Program Files/SASHome/x86/SASFoundation/9.3")

Arguments

dataSourcePath

character, Specifies the path that directs to the VRI original data soruce.

outputPath

character, Specifies the folder to save all the outputs.

equation

character, Specifies the taper equation that is used for compiler. Currently supports BEC-based (KBEC) and FIZ-based (KFIZ).

walkThru

logical, Speciefies whether the data had been collected using work through method. Default is TRUE, if it is not specified.

logMinLength

numeric, Specifies minimum length of log when doing log length adjustment, see logMatrixAdjustment for details. If missing 0.1 is used.

stumpHeight

numeric, Stump height. If missing 0.3 is used.

breastHeight

numeric, Breast height. If missing 1.3 is used.

UTOPDIB

numeric, Threshold inside-bark diameter for merchantable volume. If missing, UTOPDIB is 10.

utilLevel

numeric, Specifies utilization level in summrizing tree volumes at cluster and species level. Default is 4.

weirdUtil

character, Specifies weird utilization in summarizing tree volumes at cluster and species level. Default is no, if missing. Otherwise, a number should be provided.

siteToolsDLLPath

character, Path to SINDEX33.DLL.

sasExePath

character, Path to sas executable, i.e., sas.exe. If missing, the function takes C:/Program Files/SASHome/x86/SASFoundation/9.3 as default. However, it will cause crush if sas executable is not located in default path.

Value

This function compiles data and save outputs in outputPath and no file is returned.

Author(s)

Yong Luo

References

VRI compiler manual


bcgov/BCForestInventory documentation built on Feb. 11, 2018, 4:17 p.m.