Merge pull request #43 from EmilHvitfeldt/as_vector-functions

add as_sparse_double()

NAMESPACE

@@ -1,5 +1,6 @@
 # Generated by roxygen2: do not edit by hand
 
+export(as_sparse_double)
 export(coerce_to_sparse_data_frame)
 export(coerce_to_sparse_matrix)
 export(coerce_to_sparse_tibble)

R/coerce-vector.R

@@ -0,0 +1,34 @@
+#' Coerce numeric vector to sparse double
+#' 
+#' @param x a numeric vector.
+#' @param default default value to use. Defaults to `0`.
+#'
+#' @examples
+#' x_dense <- c(3, 0, 2, 0, 0, 0, 4, 0, 0, 0)
+#' x_sparse <- as_sparse_double(x_dense)
+#' x_sparse
+#' 
+#' is_sparse_double(x_sparse) 
+#' @export
+as_sparse_double <- function(x, default = 0) {
+  if (is_sparse_double(x)) {
+    return(x)
+  }
+
+  if ((!is.numeric(x)) || (!is.vector(x))) {
+    cli::cli_abort(
+      "{.arg x} must be numeric vector, not {.obj_type_friendly {x}}."
+    )
+  }
+
+  check_number_decimal(default)
+
+  index <- which(x != default)
+
+  sparse_double(
+    values = x[index],
+    positions = index,
+    length = length(x),
+    default = default
+  )
+}

R/coerce.R

@@ -134,4 +134,5 @@ coerce_to_sparse_data_frame <- function(x) {
 
   names(res) <- colnames(x)
   res
-}
+}
+

_pkgdown.yml

@@ -12,6 +12,7 @@ reference:
     - coerce_to_sparse_data_frame
     - coerce_to_sparse_matrix
     - coerce_to_sparse_tibble
+    - as_sparse_double
 
   - title: Helper Functions
     contents: