natverse
diff --git a/‎R/xyzmatrix.R‎
Lines changed: 9 additions & 1 deletion b/‎R/xyzmatrix.R‎
Lines changed: 9 additions & 1 deletion
diff --git a/‎man/nvertices.Rd‎
Lines changed: 1 addition & 1 deletion b/‎man/nvertices.Rd‎
Lines changed: 1 addition & 1 deletion
diff --git a/‎man/xyzmatrix.Rd‎
Lines changed: 6 additions & 2 deletions b/‎man/xyzmatrix.Rd‎
Lines changed: 6 additions & 2 deletions
diff --git a/‎tests/testthat/test-xyzmatrix.R‎
Lines changed: 11 additions & 0 deletions b/‎tests/testthat/test-xyzmatrix.R‎
Lines changed: 11 additions & 0 deletions
@@ -255,14 +255,22 @@ xyzmatrix.mesh3d<-function(x, ...){
 #'   with an object to a character vector (by default comma separated).
 #' @param format A \code{\link{sprintf}} compatible format string. The default
 #'   will give comma separated values.
+#' @param sep A character vector specifying a separator string. Overrides
+#'   \code{format} when present. The default value of \code{format} is
+#'   equivalent to \code{sep=","}.
 #' @examples
 #' head(xyzmatrix2str(kcs20[[1]]))
 #' head(xyzmatrix2str(kcs20[[1]], format="(%g;%g;%g)"))
 #' # if you want to process the xyz locations (here rounded to nearest nm)
 #' # you must extract them from complex objects yourself
 #' xyzmatrix2str(round(xyzmatrix(kcs20[[1]])*1000), format="%d,%d,%d")[1:3]
-xyzmatrix2str <- function(x, format="%g,%g,%g") {
+xyzmatrix2str <- function(x, format="%g,%g,%g", sep=NULL) {
   xyz=xyzmatrix(x)
+  if(!is.null(sep)) {
+    if(!checkmate::test_character(sep, len = 1))
+      stop("If specified, sep must be a character vector of length 1")
+    format=paste0("%g", sep, "%g", sep, "%g")
+  }
   sprintf(format, xyz[,1], xyz[,2], xyz[,3])
 }
 
 
@@ -169,6 +169,17 @@ test_that("can extract xyz coords of a character vector",{
   expect_equal(xyzmatrix(empty_target), xyzmatrix(rep))
 })
 
+test_that("can generate character representation of XYZ coords", {
+  m=matrix(1:6, ncol=3, byrow = T)
+  expect_equal(xyzmatrix2str(m),
+               c("1,2,3", "4,5,6"))
+  expect_equal(xyzmatrix2str(m), xyzmatrix2str(m, sep=","))
+  expect_equal(xyzmatrix2str(m, sep=", "), 
+               c("1, 2, 3", "4, 5, 6"))
+  expect_error(xyzmatrix2str(m, sep=0))
+  expect_equal(xyzmatrix2str(m, format="(%g;%g;%g)"), 
+               c("(1;2;3)", "(4;5;6)"))
+})
 
 test_that("can replace xyz coords of a data.frame",{
   # we just need to handle some edge cases with 0 row data here