Merge pull request #36 from datashield/v6.4.0-dev

V6.4.0 dev

Author: davraam

NAMESPACE

@@ -3,6 +3,7 @@
 export(BooleDS)
 export(absDS)
 export(asCharacterDS)
+export(asDataFrameDS)
 export(asDataMatrixDS)
 export(asFactorDS1)
 export(asFactorDS2)

R/asDataFrameDS.R

@@ -0,0 +1,29 @@
+#' @title asDataFrameDS a serverside assign function called by ds.asDataFrame
+#' @description Coerces an R object into a matrix maintaining original
+#' class for all columns in data.frames.
+#' @details This assign function is based on the native R function \code{data.frame}
+#' @param x.name the name of the input object to be coerced to class
+#' data.frame. Must be specified in inverted commas. But this argument is
+#' usually specified directly by <x.name> argument of the clientside function
+#' \code{ds.asDataFrame}
+#' @return the object specified by the <newobj> argument (or its default name
+#' "asdataframe.newobj") which is written to the serverside. For further
+#' details see help on the clientside function \code{ds.asDataMatrix}
+#' @author Tim Cadman
+#' @export
+asDataFrameDS <- function (x.name){
+  
+  if(is.character(x.name)){
+    x<-eval(parse(text=x.name), envir = parent.frame())
+    
+  }else{
+    studysideMessage<-"ERROR: x.name must be specified as a character string"
+    stop(studysideMessage, call. = FALSE)
+  }
+  
+  output <- data.frame(x)
+  
+  return(output)
+}
+# ASSIGN FUNCTION
+# asDataFrameDS

R/asDataMatrixDS.R

@@ -1,24 +1,17 @@
-#' 
-#' @title asDataMatrixDS a serverside assign function called by ds.asDataMatrix
+#' @title asDataFrameDS a serverside assign function called by ds.asDataFrame
 #' @description Coerces an R object into a matrix maintaining original
 #' class for all columns in data.frames.
-#' @details This assign function is based on the native R function \code{data.matrix}
-#' If applied to a data.frame, the native R function \code{as.matrix}
-#' coverts all columns into character class. In contrast, if applied to
-#' a data.frame the native R function \code{data.matrix} converts
-#' the data.frame to a matrix but maintains all data columns in their
-#' original class
+#' @details This assign function is based on the native R function \code{data.frame}
 #' @param x.name the name of the input object to be coerced to class
-#' data.matrix. Must be specified in inverted commas. But this argument is
+#' data.frame. Must be specified in inverted commas. But this argument is
 #' usually specified directly by <x.name> argument of the clientside function
-#' \code{ds.asDataMatrix}
+#' \code{ds.asDataFrame}
 #' @return the object specified by the <newobj> argument (or its default name
-#' "asdatamatrix.newobj") which is written to the serverside. For further
+#' "asdataframe.newobj") which is written to the serverside. For further
 #' details see help on the clientside function \code{ds.asDataMatrix}
-#' @author Paul Burton for DataSHIELD Development Team
+#' @author Tim Cadman
 #' @export
-#' 
-asDataMatrixDS <- function (x.name){
+asDataFrameDS <- function (x.name){
 
 if(is.character(x.name)){
 	x <- eval(parse(text=x.name), envir = parent.frame())
@@ -28,9 +21,9 @@ if(is.character(x.name)){
    stop(studysideMessage, call. = FALSE)
   }
 
-  output <- data.matrix(x)
+  output <- data.frame(x)
 
   return(output)
 }
 # ASSIGN FUNCTION
-# asDataMatrixDS
+# asDataFrameDS

man/asDataFrameDS.Rd

@@ -0,0 +1,47 @@
+#-------------------------------------------------------------------------------
+# Copyright (c) 2019-2022 University of Newcastle upon Tyne. All rights reserved.
+#
+# This program and the accompanying materials
+# are made available under the terms of the GNU Public License v3.0.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+#-------------------------------------------------------------------------------
+
+#
+# Set up
+#
+
+context("asDataFrameDS::smk::setup")
+
+#
+# Tests
+#
+
+context("asDataFrameDS::smk::simple")
+test_that("simple asDataFrameDS", {
+    input <- tibble(v1 = c(0.0, 1.0, 2.0, 3.0, 4.0), v2 = c(4.0, 3.0, 2.0, 1.0, 0.0))
+
+    res <- asDataFrameDS("input")
+
+    res.class <- class(res)
+    expect_length(res.class, 1)
+    expect_true("data.frame" %in% res.class)
+    expect_equal(
+      dim(res), c(5, 2)
+      )
+    
+    expect_equal(res$v1, 0:4)
+    expect_equal(res$v2, 4:0)
+    res.colnames <- colnames(res)
+    expect_length(res.colnames, 2)    
+    expect_equal(res.colnames[1], "v1")
+    expect_equal(res.colnames[2], "v2")
+})
+
+#
+# Done
+#
+
+context("asDataMatrixDS::smk::shutdown")
+context("asDataMatrixDS::smk::done")