VRICompiler: VRI compiler - VRI specific
In bcgov/BCForestGroundSample: BC forest ground sample compilation

Description Usage Arguments Value Note Author(s) References

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.

VRICompiler(oracleUserName, oraclePassword,
  asciiTxtPath = "//albers/gis_tib/VRI/RDW/RDW_Data2/Work_Areas/VRI_ASCII_PROD/vri_raw",
  compilationPath = "//albers/gis_tib/VRI/RDW/RDW_Data2/Work_Areas/VRI_ASCII_PROD/RCompilation",
  fizmapPath = "//spatialfiles2.bcgov/work/for/vic/hts/dam/workarea/data/infrastructure",
  fizmapName = "FIZ_REG_COMPARTMENT", fizmapFormat = "gdb",
  equation = "KBEC", walkThru = TRUE, logMinLength = 0.1,
  stumpHeight = 0.3, breastHeight = 1.3, UTOPDIB = 10,
  utilLevel = 4, weirdUtil = "No", useExternalCoefRatio = FALSE)

`oracleUserName`	character, User name to access to oracle database.
`oraclePassword`	character, Password to access to oracle database.
`asciiTxtPath`	character, Path to ascii txt files. By default, the arguement is specified to `//albers/gis_tib/VRI/RDW/RDW_Data2/Work_Areas/VRI_ASCII_PROD/vri_raw`. However, user can modify.
`compilationPath`	character, Specifies the path that stores all the data/processes. By specifying this, four folders will be created to record all the data/processes. Specifically, raw_from_oracle stores the data just after oracle and ascii without editing; compilation_sa stores key data (not all) that after editing and before volume and age compilation; compilation_db stores compiled results for volume and age compilation at both tree level and cluater level; Archive_YYYYMMDD achives all the data mentioned above for the future use or reference. By default, this path is set as `//albers/gis_tib/VRI/RDW/RDW_Data2/Work_Areas/VRI_ASCII_PROD/RCompilation`, which is consistent with our rdw system.
`fizmapPath`	character, Specifies the path to forest inventory zone map. By default, it is set to `//spatialfiles2.bcgov/work/for/vic/hts/dam/workarea/data/infrastructure`, which is maintained by FAIB employee.
`fizmapName`	character, Specifies the name of forest inventory zone map. By default, it is set to `FIZ_REG_COMPARTMENT`, which is maintained by FAIB employee.
`fizmapFormat`	character, Specifies the format of forest inventory zone map. Currently, it can be specified as `gdb` for geodatabase format and `shp` for shapefile format. By default, it is set to `gdb`, which is maintained by FAIB employee.
`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.
`useExternalCoefRatio`	logical, Allow users to use prederived regression and ratio. Default is `FALSE` for now.

This function compiles data and save outputs in compilationPaths$compilation_db and no file is returned.

Improvements include:

specifies trees in B plots as height enhanced trees
removes the sas-dependent sindex functions
introduce the SIndexR package

Currently, the compiler supports compilation for the below sample types:

Q: Regular VRI sample with five point clusters design
T: ??, sample protocol and sample design are same as Q samples
B: ??, same plot layout as Q sample, with height is measured for all trees and no call grading information
M: CMI sample, with all trees have call grading information in the field
L: LiDAR project, same plot layout and same design but without call grading information
Y: YSM plots, population between 15 and 50 years
F: NFI plots, trees measured all DBH, height and call grading
N: NVAF plots
A: VRI audit plots