Add log2()<-, log10()<-, ilog2(), and ilog10() functions

NAMESPACE

@@ -20,6 +20,8 @@ S3method(numericise,hms)
 S3method(numericise,integer)
 S3method(numericise,logical)
 S3method(numericise,matrix)
+export("log10<-")
+export("log2<-")
 export("log<-")
 export("log_odds<-")
 export("logit<-")
@@ -42,10 +44,14 @@ export(dev_norm)
 export(dev_pois)
 export(dev_pois_zi)
 export(dev_student)
+export(exp10)
+export(exp2)
 export(fabs)
 export(fill_all)
 export(fill_na)
 export(ilog)
+export(ilog10)
+export(ilog2)
 export(ilogit)
 export(inv_logit)
 export(inv_odds)

R/exp.R

@@ -0,0 +1,29 @@
+#' Exponential Transformation of Base 2
+#'
+#' Returns the transformation of 2^x.
+#'
+#' @param x An numeric atomic object.
+#' @family translations
+#' @return A numeric atomic object with the value of 2^x.
+#' @export
+#' @examples
+#' x <- c(5, 10.5)
+#' exp2(x)
+exp2 <- function(x) {
+  2^x
+}
+
+#' Exponential Transformation of Base 10
+#'
+#' Returns the transformation of 10^x.
+#'
+#' @param x An numeric atomic object.
+#' @family translations
+#' @return A numeric atomic object with the value of 10^x.
+#' @export
+#' @examples
+#' x <- c(5, 10.5)
+#' exp10(x)
+exp10 <- function(x) {
+  10^x
+}

R/log.R

@@ -4,7 +4,7 @@
 #'
 #' @details A wrapper on [`exp`]`(value)`.
 #'
-#' @param x An existing R object.
+#' @inheritParams params
 #' @param value A numeric atomic object.
 #' @family translations
 #' @return Called for the side effect of updating `x`.
@@ -17,13 +17,51 @@
   exp(value)
 }
 
+#' Log Base 2 Transformation
+#'
+#' Replaces a object with the base 2 exponent of value.
+#'
+#' @details A wrapper on [`exp2`]`(value)`.
+#'
+#' @inheritParams params
+#' @param value A numeric atomic object.
+#' @family translations
+#' @return Called for the side effect of updating `x`.
+#' @export
+#' @examples
+#' x <- NULL
+#' log2(x) <- c(0.5, 5)
+#' x
+`log2<-` <- function(x, value) {
+  exp2(value)
+}
+
+#' Log Base 10 Transformation
+#'
+#' Replaces a object with the base 10 exponent of value.
+#'
+#' @details A wrapper on [`exp10`]`(value)`.
+#'
+#' @inheritParams params
+#' @param value A numeric atomic object.
+#' @family translations
+#' @return Called for the side effect of updating `x`.
+#' @export
+#' @examples
+#' x <- NULL
+#' log10(x) <- c(0.5, 5)
+#' x
+`log10<-` <- function(x, value) {
+  exp10(value)
+}
+
 #' Inverse Log Transformation
 #'
 #' Inverse log transforms a numeric atomic object.
 #'
 #' @details A wrapper on [`exp`]`(value)`.
 #'
-#' @param x A numeric atomic object.
+#' @inheritParams params
 #' @family translations
 #' @return A numeric atomic object.
 #' @export
@@ -34,3 +72,39 @@
 ilog <- function(x) {
   exp(x)
 }
+
+#' Inverse Log Base 2 Transformation
+#'
+#' Inverse log transforms a numeric atomic object with base 2.
+#'
+#' @details A wrapper on [`exp2`]`(value)`.
+#'
+#' @inheritParams params
+#' @family translations
+#' @return A numeric atomic object.
+#' @export
+#' @examples
+#' x <- c(2, 4.5)
+#' ilog2(x)
+
+ilog2 <- function(x) {
+  exp2(x)
+}
+
+#' Inverse Log Base 10 Transformation
+#'
+#' Inverse log transforms a numeric atomic object with base 10.
+#'
+#' @details A wrapper on [`exp10`]`(value)`.
+#'
+#' @inheritParams params
+#' @family translations
+#' @return A numeric atomic object.
+#' @export
+#' @examples
+#' x <- c(2, 4.5)
+#' ilog10(x)
+
+ilog10 <- function(x) {
+  exp10(x)
+}

_pkgdown.yml

@@ -27,10 +27,16 @@ reference:
   desc: Conversion functions
   contents:
   - '`fabs`'
+  - '`exp2`'
+  - '`exp10`'
   - '`ilog`'
+  - '`ilog2`'
+  - '`ilog10`'
   - '`ilogit`'
   - '`invlogit`'
   - '`inv_odds`'
+  - '`log2<-`'
+  - '`log10<-`'
   - '`logit`'
   - '`odds`'
   - '`phi`'