rename crown_overlay_pct() to overlay_crowns()

Author: ctoney

NAMESPACE

@@ -3,4 +3,4 @@
 export(.get_tree_list_xy)
 export(create_fia_owin)
 export(create_fia_ppp)
-export(crown_overlay_pct)
+export(overlay_crowns)

R/crown_overlay_pct.R R/overlay_crowns.RR/crown_overlay_pct.R renamed to R/overlay_crowns.R

@@ -1,6 +1,6 @@
 #' Compute fractional tree canopy cover of a subplot/microplot by crown overlay
 #'
-#' `crown_overlay_pct()` computes the proportion of a circular polygon covered
+#' `overlay_crowns()` 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,9 +27,9 @@
 #' # subplot 1 of the `plantation` plot
 #' subp1_trees <- plantation[plantation$SUBP == 1 &
 #'                           plantation$DIA >= 5, ]
-#' crown_overlay_pct(subp1_trees, 24)
+#' overlay_crowns(subp1_trees, 24)
 #' @export
-crown_overlay_pct <- function(tree_list, sample_radius, digits = 1) {
+overlay_crowns <- function(tree_list, sample_radius, digits = 1) {
     if (missing(tree_list) || is.null(tree_list))
         stop("'tree_list' is required", call. = FALSE)
 

_pkgdown.yml

@@ -20,5 +20,5 @@ reference:
 
 - title: Functions
 - contents:
-  - crown_overlay_pct
+  - overlay_crowns
   - spatstat_helpers

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

@@ -1,8 +1,8 @@
-test_that("crown_overlay_pct works", {
+test_that("overlay_crowns 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(round(crown_overlay_pct(trees, 24)), 20)
+    expect_equal(round(overlay_crowns(trees, 24)), 20)
 })