Add generic alias for cal_sum()

NAMESPACE

@@ -16,6 +16,7 @@ S3method(format,c14_curve_14c)
 S3method(format,c14_curve_f14c)
 S3method(obj_print_data,c14_cal)
 S3method(pillar_shaft,c14_cal)
+S3method(sum,c14_cal)
 S3method(vec_ptype_abbr,c14_cal)
 S3method(vec_ptype_abbr,c14_curve_14c)
 S3method(vec_ptype_abbr,c14_curve_f14c)

R/cal_aggregate.R

@@ -33,6 +33,12 @@ cal_sum <- function(x, range = cal_age_common(x), normalise = FALSE, ...) {
   new_cal(list(data.frame(age = cal_age(x)[[1]], pdens = pdens_sum)))
 }
 
+#' @rdname cal_sum
+#' @export
+sum.c14_cal <- function(x, range = cal_age_common(x), normalise = FALSE, ...) {
+  cal_sum(x, range = range, normalise = normalise, ...)
+}
+
 #' Kernel density estimation of calendar probability distributions
 #'
 #' Aggregates calibrated radiocarbon dates and other calendar probability

tests/testthat/test-cal_aggregate.R

@@ -8,6 +8,10 @@ test_that("cal_sum(normalise = TRUE) normalised pdens to 1", {
   expect_equal(sum(cal_pdens(cal_sum(x, normalise = TRUE))[[1]]), 1)
 })
 
+test_that("sum() is an alias of cal_sum() for cal objects", {
+  expect_equal(sum(x), cal_sum(x))
+})
+
 test_that("cal_density() has the expected prototype", {
   expect_vector(
     cal_density(x),