remove unused SPGRPCD, remove CRWIDTH from plantation and compute as needed

Author: ctoney

R/data.R

@@ -132,7 +132,7 @@ DEFAULT_TREE_COLUMNS <- c("PLT_CN", "SUBP", "TREE", "AZIMUTH", "DIST",
 #' An example tree list for an FIA plot in a loblolly pine plantation.
 #'
 #' @format ## `plantation`
-#' A data frame with 91 rows and 14 columns:
+#' A data frame with 91 rows and 12 columns:
 #' \describe{
 #'   \item{\code{PLT_CN}}{\code{\link{character}}, Plot unique identifier}
 #'   \item{\code{SUBP}}{\code{\link{integer}}, Subplot number}
@@ -144,7 +144,6 @@ DEFAULT_TREE_COLUMNS <- c("PLT_CN", "SUBP", "TREE", "AZIMUTH", "DIST",
 #'   \item{\code{STATUSCD}}{\code{\link{integer}},
 #'     Tree status code: 1 = live, 2 = standing dead}
 #'   \item{\code{SPCD}}{\code{\link{integer}}, FIA tree species code}
-#'   \item{\code{SPGRPCD}}{\code{\link{integer}}, FIA tree species group code}
 #'   \item{\code{DIA}}{\code{\link{numeric}},
 #'     Tree diameter at breast height in inches}
 #'   \item{\code{HT}}{\code{\link{integer}}, Tree height in feet}
@@ -153,8 +152,6 @@ DEFAULT_TREE_COLUMNS <- c("PLT_CN", "SUBP", "TREE", "AZIMUTH", "DIST",
 #'   \item{\code{CCLCD}}{\code{\link{integer}}, Tree crown class code}
 #'   \item{\code{TPA_UNADJ}}{\code{\link{numeric}},
 #'     Trees per acre expansion factor}
-#'   \item{\code{CRWIDTH}}{\code{\link{numeric}},
-#'     Estimated tree crown width in feet}
 #' }
 #' @source <https://research.fs.usda.gov/programs/nfi>
 "plantation"

R/overlay_crowns.R

@@ -25,9 +25,9 @@
 #'
 #' @examples
 #' # subplot 1 of the `plantation` plot
-#' subp1_trees <- plantation[plantation$SUBP == 1 &
-#'                           plantation$DIA >= 5, ]
-#' overlay_crowns(subp1_trees, 24)
+#' trees <- within(plantation, CRWIDTH <- predict_crwidth(plantation))
+#' trees[trees$SUBP == 1 & trees$DIA >= 5, ] |>
+#'   overlay_crowns(sample_radius = 24)
 #' @export
 overlay_crowns <- function(tree_list, sample_radius, digits = 1) {
     if (missing(tree_list) || is.null(tree_list))

R/spatstat_helpers.R

@@ -26,13 +26,12 @@
 #' * `DIST`: required distance from subplot center
 #' * `STATUSCD`: required tree status code (1 = live, 2 = dead)
 #' * `SPCD`: optional FIA species code
-#' * `SPGRPCD`: optional FIA species group code
 #' * `DIA`: optional tree diameter
 #' * `HT`: optional tree height
 #' * `ACTUALHT`: optional tree actual height (accounts for broken top)
 #' * `CCLCD`: optional crown class code
 #' * `TPA_UNADJ`: optional tree expansion factor (per acre)
-#' * `CRWIDTH`: optional crown width (may be computed with **TODO**)
+#' * `CRWIDTH`: optional crown width (see `predict_crwidth()`)
 #'
 #' @param linear_unit An optional character string specifying the linear
 #' distance unit. Defaults to the native FIA unit of `"ft"`, but may be set to