rename overlay_crowns() to calc_crown_overlay()

Author: ctoney

NAMESPACE

@@ -3,10 +3,10 @@
 export(.get_fia_plot_geom)
 export(.get_tree_list_xy)
 export(DEFAULT_TREE_COLUMNS)
+export(calc_crown_overlay)
 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)

R/overlay_crowns.R R/calc_crown_overlay.RR/overlay_crowns.R renamed to R/calc_crown_overlay.R

@@ -1,6 +1,6 @@
 #' Compute fractional tree canopy cover of a subplot/microplot by crown overlay
 #'
-#' `overlay_crowns()` computes the proportion of a circular polygon covered
+#' `calc_crown_overlay()` computes the proportion of a circular polygon covered
 #' by a given set of tree crowns modeled as discs and having spatially explicit
 #' stem locations. The sampled area is generally an FIA subplot with radius 24
 #' ft (7.315 m) for trees with diameter \verb{>= 5 in.} (12.7 cm), or an FIA
@@ -27,11 +27,11 @@
 #' # subplot 1 of the `plantation` plot
 #' trees <- within(plantation, CRWIDTH <- calc_crwidth(plantation))
 #' trees[trees$SUBP == 1 & trees$DIA >= 5, ] |>
-#'   overlay_crowns(sample_radius = 24)
+#'   calc_crown_overlay(sample_radius = 24)
 #'
 #' plot_crowns(trees, subplot = 1, main = "plantation subplot 1")
 #' @export
-overlay_crowns <- function(tree_list, sample_radius, digits = 1) {
+calc_crown_overlay <- function(tree_list, sample_radius, digits = 1) {
     if (missing(tree_list) || is.null(tree_list))
         stop("'tree_list' is required", call. = FALSE)
 

_pkgdown.yml

@@ -14,10 +14,10 @@ home:
 reference:
 - title: Functions
 - contents:
+  - calc_crown_overlay
   - calc_crwidth
   - calc_ht_metrics
   - load_tree_data
-  - overlay_crowns
   - plot_crowns
   - spatstat_helpers
 

man/overlay_crowns.Rd man/calc_crown_overlay.Rdman/overlay_crowns.Rd renamed to man/calc_crown_overlay.Rd

@@ -1,8 +1,8 @@
-test_that("overlay_crowns works", {
+test_that("calc_crown_overlay works", {
     # test tree list used in the original subp_crcov.c
     trees <- c(117,22.1,7.71,72,19.4,10.0,66,17.3,8.94,258,13.2,17.28) |>
         matrix(nrow = 4, ncol = 3, byrow = TRUE) |>
         as.data.frame()
     colnames(trees) <- c("AZIMUTH", "DIST", "CRWIDTH")
-    expect_equal(overlay_crowns(trees, 24, 0), 20)
+    expect_equal(calc_crown_overlay(trees, 24, 0), 20)
 })