R/popTableIDs.R

In FIESTAutils: Utility Functions for Forest Inventory Estimation and Analysis

#' List of population table unique IDs.
#' 
#' Returns a list of user-supplied parameters and parameter values for data 
#' table unique IDs to be supplied to *pop functions. 
#' 
#' If no parameters, an empty list is returned.
#' 
#' @param cond String. Unique identifier of plot in cond.
#' @param plt String. Unique identifier of plot in plt.
#' @param tree String. Unique identifier of plot in tree and seed.
#' @param seed String.
#' @param seedling String.
#' @param vsubpspp String.
#' @param p2veg_subplot_spp String.
#' @param vsubpstr String.
#' @param p2veg_subp_structure String.
#' @param invsubp String.
#' @param invasive_subplot_spp String.
#' @param subplot String.
#' @param subp_cond String. 
#' @param dwm String.
#' @param cond_dwm_calc String. 
#' @param sccm String. 
#' @param subp_cond_chng_mtrx String. 
#' @param grm String.
#' @param tree_grm_component String. 
#' @param begin String. 
#' @param tree_grm_begin String. 
#' @param midpt String. 
#' @param tree_grm_midpt String. 
#' @param plot String. 
#' @param pltu String.
#' @param plotu String. 
#' @param condu String. 
#' @param ... For extendibility.
#' @return A list of user-supplied unique identifier of a plot in population tables.
#' @author Grayson W. White
#' @keywords list
#' @export popTableIDs
popTableIDs <- function(cond = "PLT_CN", 
                        plt = "CN", 
                        tree = "PLT_CN", 
                        seed = "PLT_CN",
						            seedling = "PLT_CN",
                        vsubpspp = "PLT_CN", 
						            p2veg_subplot_spp = "PLT_CN",
                        vsubpstr = "PLT_CN",
						            p2veg_subp_structure = "PLT_CN",
                        invsubp = "PLT_CN", 
						            invasive_subplot_spp = "PLT_CN",
                        subplot = "PLT_CN",
                        subp_cond = "PLT_CN", 
						            dwm = "PLT_CN",
                        cond_dwm_calc = "PLT_CN",
                        sccm = "PLT_CN", 
					              subp_cond_chng_mtrx = "PLT_CN",
                        grm = "PLT_CN",
					              tree_grm_component = "PLT_CN",
                        begin = "PLT_CN",
						            tree_grm_begin = "PLT_CN",
                        midpt = "PLT_CN",
						            tree_grm_midpt = "PLT_CN",
						            plot = "CN",
						            pltu = "CN",
						            plotu = "CN",
						            condu = "PLT_CN",
                       ...) {
  # Check input parameters
  input.params <- names(as.list(match.call()))[-1]
  formallst <- c(names(formals(popTableIDs)))
  if (!all(input.params %in% formallst)) {
    miss <- input.params[!input.params %in% formallst]
    stop("invalid parameter: ", toString(miss))
  }
  
  # removes input parameters to create l correctly
  rm(input.params, formallst)
  
  # create list from input parameters
  l <- c(as.list(environment()), list(...))
  
  # return list
  return(l)
}