R/VRIInit_lossFactor.R

In bcgov/BCForestGroundSample: BC forest ground sample compilation

#' Load and select trees that have loss factor information-VRI specific
#'
#' @description This function loads and selects trees that have loss factor information (\code{vi_d}, cardd) based on
#'              selected trees from vi_c.
#'
#' @param fullMeasuredTrees data.table, Selected trees in vi_c, which includes full, enhanced and H-enhanced trees.
#'                                      An output of \code{\link{VRIInit_measuredTree}}.
#'
#' @param dataSourcePath character, Specifies the path that directs to the VRI original data soruce, i.e.,
#'                                  \code{//Mayhem/GIS_TIB/RDW/RDW_Data2/Work_Areas/VRI_ASCII_PROD/vri_sa}.
#'
#'
#' @return A data table that contains loss factor data. A log file documents the detailed process
#'
#'
#' @importFrom data.table data.table ':=' set rbindlist setnames setkey
#' @importFrom dplyr '%>%'
#' @export
#' @docType methods
#' @rdname VRIInit_lossFactor
#'
#' @author Yong Luo
#'
VRIInit_lossFactor<- function(fullMeasuredTrees,
                        dataSourcePath){
    lossfactors <- readRDS(file.path(dataSourcePath, "vi_d.rds")) %>% data.table
    names(lossfactors) <- toupper(names(lossfactors))
    lossfactors <- lossfactors[, c("CLSTR_ID", "PLOT", "TREE_NO", paste("LOSS", 1:8, "_IN", sep = ""),
                                   paste("LOC", 1:8, "_FRO", sep = "")), with = FALSE]
    lossfactors <- unique(lossfactors, by = c("CLSTR_ID", "PLOT", "TREE_NO"))
    fullMeasuredTrees[, clusterplottree := paste(CLSTR_ID, "_", PLOT, "_", TREE_NO, sep = "")]
    lossfactors[, clusterplottree := paste(CLSTR_ID, "_", PLOT, "_", TREE_NO, sep = "")]
    lossfactors <- lossfactors[clusterplottree %in% fullMeasuredTrees$clusterplottree,]
    lossfactors[, ':='(clusterplottree = NULL)]
    return(lossfactors)
  }