rename predict_crwidth() to calc_crwidth()

Author: ctoney

NAMESPACE

@@ -3,10 +3,10 @@
 export(.get_fia_plot_geom)
 export(.get_tree_list_xy)
 export(DEFAULT_TREE_COLUMNS)
+export(calc_crwidth)
 export(calc_ht_metrics)
 export(create_fia_owin)
 export(create_fia_ppp)
 export(load_tree_data)
 export(overlay_crowns)
 export(plot_crowns)
-export(predict_crwidth)

R/predict_crwidth.R R/calc_crwidth.RR/predict_crwidth.R renamed to R/calc_crwidth.R

@@ -1,6 +1,6 @@
 #' Compute predicted tree crown width using species-specific equations
 #'
-#' `predict_crwidth()` computes tree crown width using species-specific
+#' `calc_crwidth()` computes tree crown width using species-specific
 #' regression equations from the literature.
 #'
 #' @details
@@ -16,7 +16,7 @@
 #' region can far exceed the range of diameters in the broadly applicable
 #' datasets that have been used to develop crown width prediction equations. To
 #' avoid extrapolation beyond the range of the model fitting data in those
-#' cases, `predict_crwidth()` makes use of the "old growth" equation presented
+#' cases, `calc_crwidth()` makes use of the "old growth" equation presented
 #' by Gill et al. (2000) to estimate crown width for nine tree species when
 #' their diameter is greater than 50 in. (127 cm).
 #'
@@ -35,9 +35,9 @@
 #' 405-416.
 #'
 #' @examples
-#' predict_crwidth(plantation)
+#' calc_crwidth(plantation)
 #' @export
-predict_crwidth <- function(tree_list, digits = 1) {
+calc_crwidth <- function(tree_list, digits = 1) {
     if (missing(tree_list) || is.null(tree_list))
         stop("'tree_list' is required", call. = FALSE)
 

R/overlay_crowns.R

@@ -25,7 +25,7 @@
 #'
 #' @examples
 #' # subplot 1 of the `plantation` plot
-#' trees <- within(plantation, CRWIDTH <- predict_crwidth(plantation))
+#' trees <- within(plantation, CRWIDTH <- calc_crwidth(plantation))
 #' trees[trees$SUBP == 1 & trees$DIA >= 5, ] |>
 #'   overlay_crowns(sample_radius = 24)
 #'

R/plot_crowns.R

@@ -38,7 +38,7 @@
 #' The input, invisibly.
 #'
 #' @examples
-#' trees <- within(plantation, CRWIDTH <- predict_crwidth(plantation))
+#' trees <- within(plantation, CRWIDTH <- calc_crwidth(plantation))
 #'
 #' plot_crowns(trees, main = "plantation plot")
 #'

R/spatstat_helpers.R

@@ -31,7 +31,7 @@
 #' * `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 (see `predict_crwidth()`)
+#' * `CRWIDTH`: optional crown width (see `calc_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

_pkgdown.yml

@@ -14,11 +14,11 @@ home:
 reference:
 - title: Functions
 - contents:
+  - calc_crwidth
   - calc_ht_metrics
   - load_tree_data
   - overlay_crowns
   - plot_crowns
-  - predict_crwidth
   - spatstat_helpers
 
 - title: Data