Improved compatibility with list casting operations and added unclassing to as.list

CHANGELOG.md

@@ -4,11 +4,17 @@ All notable changes to this project will be documented in this file.
 
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## v0.4.2
+
+### Improvements
+
+-   Improved compatibility of `dsoParams` with list operations
+
 ## v0.4.1
 
 ### Improvements
 
-- Improve the readability of `dsoParams` object using `read_params()`
+-   Improve the readability of `dsoParams` object using `read_params()`
 
 ## v0.4.0
 

DESCRIPTION

@@ -1,7 +1,7 @@
 Package: dso
 Type: Package
 Title: dso R companion package 
-Version: 0.4.0
+Version: 0.4.2
 Author: Daniel Schreyer<[email protected]>,
     Gregor Sturm<[email protected]>, 
     Thomas Schwarzl<[email protected]>

NAMESPACE

@@ -11,6 +11,7 @@ export(read_params)
 export(safe_get)
 export(set_stage)
 export(stage_here)
+exportMethods(as.list)
 exportMethods(show)
 importFrom(glue,glue)
 importFrom(here,here)

R/class-dsoParams.R

@@ -27,7 +27,7 @@ dsoParams <- function( x = list()) {
         y
       }
   })
-  class(x) <- "dsoParams"
+  class(x) <- c("dsoParams", "list")
   return(x)
 }
 
@@ -68,3 +68,21 @@ setMethod(f = "show",
           definition = function(object) {
             cat(yaml::as.yaml(object))
           })
+
+# Custom as.list method for dsoParams class
+#' @export
+setMethod(
+  f = "as.list",  
+  signature = "dsoParams",
+  definition = function(x) {
+    lapply(x, function(y) {
+      if("dsoParams" %in% class(y)) {
+        as.list(unclass(y))
+      } else {
+        x
+      }
+    })
+  }
+)
+
+

tests/testthat/test-class-dsoParams.R

@@ -7,10 +7,11 @@ test_that("dsoParams() creation of dsoParams objects", {
   y$a <- list()
   y$b <- "b"
   y$a$c <- "c"
-  y <- dsoParams(y)
+  z <- dsoParams(y)
+
+  expect_s3_class(z, "dsoParams")
+  expect_s3_class(z$a, "dsoParams")
 
-  expect_s3_class(y, "dsoParams")
-  expect_s3_class(y$a, "dsoParams")
 })
 
 
@@ -74,3 +75,32 @@ test_that("access to dsoParams() with $ and [[", {
   expect_error(params[[var_z]][[var_c]], "does not exist")
 })
 
+test_that("dsoParams: as.list() convertion", {
+  y <- list()
+  y$a <- list()
+  y$b <- "b"
+  y$a$c <- "c"
+  y$a$d <- "d"
+  y$a$e <- list()
+  y$a$e$f <- "f"
+  z <- dsoParams(y)
+
+  l_z <- as.list(z)
+  expect_type(l_z, "list")
+  expect_equal(class(l_z), "list")
+})
+
+test_that("dsoParams: as.data.frame() convertion", {
+  y <- list()
+  y$a <- list()
+  y$b <- "b"
+  y$a$c <- "c"
+  y$a$d <- "d"
+  y$a$e <- list()
+  y$a$e$f <- "f"
+  z <- dsoParams(y)
+
+  l_z <- as.data.frame(z)
+  expect_s3_class(l_z, "data.frame")
+})
+