u() / du(): allow creation and dropping of dimensionless "units".

lschneiderbauer · Dec 28, 2024 · 3952618 · 3952618
1 parent 2b6784e
commit 3952618
Show file tree

Hide file tree

Showing 4 changed files with 12 additions and 4 deletions.
diff --git a/R/units.R b/R/units.R
@@ -17,7 +17,7 @@
 #' u(100, "m") > u(1, "km")
 #'
 #' @export
-u <- function(x, unit) {
+u <- function(x, unit = "1") {
   stopifnot(is.numeric(x))
   stopifnot(is.character(unit))
   # x must be a pure number
@@ -46,9 +46,12 @@ u <- function(x, unit) {
 #'  # from x in units of "meter"
 #'  du(x, "m")
 #'
+#'  # drop the unit of a dimensionaless "unit" quantity
+#'  du(x / x)
+#'
 #' @seealso [units::drop_units()]
 #' @export
-du <- function(x, unit) {
+du <- function(x, unit = "1") {
   stopifnot(inherits(x, "units"))
 
   if (has_comp_unit(x, unit)) {

diff --git a/man/du.Rd b/man/du.Rd
diff --git a/man/u.Rd b/man/u.Rd
diff --git a/tests/testthat/test-units.R b/tests/testthat/test-units.R
@@ -21,4 +21,6 @@ test_that("du() works", {
 
   expect_equal(du(x, "m"), 1000)
   expect_error(du(x, "Hz"))
+
+  expect_equal(du(x/x), 1)
 })