rename compute_ht_metrics() to calc_ht_metrics()

Author: ctoney

NAMESPACE

@@ -3,7 +3,7 @@
 export(.get_fia_plot_geom)
 export(.get_tree_list_xy)
 export(DEFAULT_TREE_COLUMNS)
-export(compute_ht_metrics)
+export(calc_ht_metrics)
 export(create_fia_owin)
 export(create_fia_ppp)
 export(load_tree_data)

R/compute_ht_metrics.R R/calc_ht_metrics.RR/compute_ht_metrics.R renamed to R/calc_ht_metrics.R

@@ -1,6 +1,6 @@
-#' Compute plot-level stand height metrics
+#' Calculate plot-level stand height metrics
 #'
-#' `compute_ht_metrics()` computes several stand height metrics for a given FIA
+#' `calc_ht_metrics()` computes several stand height metrics for a given FIA
 #' plot, i.e., across the full four-subplot cluster (see Details).
 #'
 #' @details
@@ -37,10 +37,10 @@
 #' in Details.
 #'
 #' @examples
-#' compute_ht_metrics(plantation)
+#' calc_ht_metrics(plantation)
 #'
 #' @export
-compute_ht_metrics <- function(tree_list, digits = 1) {
+calc_ht_metrics <- function(tree_list, digits = 1) {
 
     if (missing(tree_list) || is.null(tree_list))
         stop("'tree_list' is required", call. = FALSE)

_pkgdown.yml

@@ -14,7 +14,7 @@ home:
 reference:
 - title: Functions
 - contents:
-  - compute_ht_metrics
+  - calc_ht_metrics
   - load_tree_data
   - overlay_crowns
   - plot_crowns

man/compute_ht_metrics.Rd man/calc_ht_metrics.Rdman/compute_ht_metrics.Rd renamed to man/calc_ht_metrics.Rd

@@ -1,4 +1,4 @@
-test_that("compute_ht_metrics works", {
+test_that("calc_ht_metrics works", {
     expected <- vector(mode = "list", length = 8)
     names(expected) <- c("meanTreeHt", "meanTreeHtBAW", "meanTreeHtDom",
                          "meanTreeHtDomBAW", "maxTreeHt", "predomTreeHt",
@@ -11,5 +11,5 @@ test_that("compute_ht_metrics works", {
     expected$predomTreeHt <- 50.3
     expected$meanSapHt <- 33.5
     expected$maxSapHt <- 42
-    expect_equal(compute_ht_metrics(plantation), expected, tolerance = 0.1)
+    expect_equal(calc_ht_metrics(plantation), expected, tolerance = 0.1)
 })