Merge pull request #24 from robertzk/is_pre_stagerunner

is_pre_stagerunner helper
syberia · Mar 7, 2015 · c48550e · c48550e
2 parents c1f72ac + 1377904
commit c48550e
Show file tree

Hide file tree

Showing 46 changed files with 116 additions and 46 deletions.
diff --git a/DESCRIPTION b/DESCRIPTION
@@ -4,7 +4,7 @@ Description: Stage Runner is an R package that helps with parametrizing
     and executing linear sequences of actions, common in the various
     stages of data analysis: data import, munging, modeling, export,
     and visualization.
-Version: 0.4.0
+Version: 0.4.1
 Author: Robert Krzyzanowski <technoguyrob@gmail.com>
 Maintainer: Robert Krzyzanowski <technoguyrob@gmail.com>
 Authors@R: c(person("Robert", "Krzyzanowski",

diff --git a/NAMESPACE b/NAMESPACE
@@ -1,7 +1,8 @@
-# Generated by roxygen2 (4.1.0.9000): do not edit by hand
+# Generated by roxygen2 (4.1.0): do not edit by hand
 
 export(is.stageRunner)
 export(is.stagerunner)
+export(is_pre_stagerunner)
 export(stageRunner)
 import(testthat)
 import(testthatsomemore)
diff --git a/NEWS.md b/NEWS.md
@@ -1,3 +1,8 @@
+# Version 0.4.1
+
+* Added an `is_pre_stagerunner` helper function that returns TRUE or FALSE
+  according as an object can be transformed into a stageRunner.
+
 # Version 0.4.0
 
 * Integration with the [objectdiff package](http://github.com/robertzk/objectdiff).

diff --git a/R/is_pre_stagerunner.R b/R/is_pre_stagerunner.R
@@ -0,0 +1,32 @@
+#' Whether or not an object can be transformed into a stageRunner.
+#'
+#' @param x ANY. An R object for which it will be determined whether or not
+#'    it admits a conversion to a stageRunner.
+#' @return TRUE or FALSE according to whether the object can be transformed
+#'    to a stageRunner. In general, only a function or list of functions
+#'    can be turned into a stageRunner.
+#' @export
+#' @examples
+#' stopifnot(is_pre_stagerunner(function(e) { e$x <- 1 }))
+#' stopifnot(is_pre_stagerunner(list(function(e) { e$x <- 1 }, function(e) { e$y <- 2 })))
+#' stopifnot(is_pre_stagerunner(
+#'   list(a = function(e) { e$x <- 1 },
+#'     list(b = function(e) { e$y <- 2 }, c = function(e) { e$z <- 3 }))))
+#' 
+#' stopifnot(!is_pre_stagerunner(NULL))
+#' stopifnot(!is_pre_stagerunner(5))
+#' stopifnot(!is_pre_stagerunner(iris))
+is_pre_stagerunner <- function(x) {
+  if (is.function(x) || is.stagerunner(x)) { return(TRUE) }
+  if (!is.recursive(x)) { return(FALSE) }
+
+  for (i in seq_along(x)) {
+    if (!(is.function(x[[i]]) || is.stagerunner(x[[i]]) || is.null(x[[i]]) ||
+          (is.recursive(x[[i]]) && Recall(x[[i]])))) {
+      return(FALSE)
+    }
+  }
+
+  TRUE
+}
+
diff --git a/R/stage_runner.r b/R/stage_runner.r
@@ -58,10 +58,10 @@ stageRunner__initialize <- function(context, .stages, remember = FALSE,
     warning("stageRunners with zero stages may cause problems.", .call = FALSE)
   }
 
-  legal_types <- function(x) is.function(x) || all(vapply(x,
-    function(s) is.function(s) || is.stagerunner(s) || is.null(s) ||
-      (is.list(s) && legal_types(s)), logical(1)))
-  stopifnot(legal_types(.stages))
+  if (!is_pre_stagerunner(.stages)) {
+    stop("Can only turn a function or list of functions into a stageRunner", call. = FALSE)
+  }
+
   if (is.function(.stages)) .stages <- list(.stages)
   stages <<- .stages
 

diff --git a/inst/tests/test-stage_runner.r b/inst/tests/test-stage_runner.r
@@ -221,7 +221,7 @@ test_that("it correctly references a numeric stage within a character stage", {
 
 test_that("it throws an error when an invalid stage gets passed", {
   expect_that(stageRunner$new(new.env(), list(1)),
-              throws_error('legal_types.*not TRUE'))
+              throws_error('Can only turn a function'))
 })
 
 test_that("it correctly parses a nested list of functions into nested stagerunners", {

diff --git a/man/OOP_type_independent_method.Rd b/man/OOP_type_independent_method.Rd
@@ -1,4 +1,4 @@
-% Generated by roxygen2 (4.1.0.9000): do not edit by hand
+% Generated by roxygen2 (4.1.0): do not edit by hand
 % Please edit documentation in R/utils.r
 \name{OOP_type_independent_method}
 \alias{OOP_type_independent_method}

diff --git a/man/boolean_fill.Rd b/man/boolean_fill.Rd
@@ -1,4 +1,4 @@
-% Generated by roxygen2 (4.1.0.9000): do not edit by hand
+% Generated by roxygen2 (4.1.0): do not edit by hand
 % Please edit documentation in R/boolean_fill.r
 \name{boolean_fill}
 \alias{boolean_fill}

diff --git a/man/compare_stage_keys.Rd b/man/compare_stage_keys.Rd
@@ -1,4 +1,4 @@
-% Generated by roxygen2 (4.1.0.9000): do not edit by hand
+% Generated by roxygen2 (4.1.0): do not edit by hand
 % Please edit documentation in R/compare_stage_keys.r
 \name{compare_stage_keys}
 \alias{compare_stage_keys}

diff --git a/man/copy_env.Rd b/man/copy_env.Rd
@@ -1,4 +1,4 @@
-% Generated by roxygen2 (4.1.0.9000): do not edit by hand
+% Generated by roxygen2 (4.1.0): do not edit by hand
 % Please edit documentation in R/copy_env.r
 \name{copy_env}
 \alias{copy_env}

diff --git a/man/is.stagerunner.Rd b/man/is.stagerunner.Rd
@@ -1,4 +1,4 @@
-% Generated by roxygen2 (4.1.0.9000): do not edit by hand
+% Generated by roxygen2 (4.1.0): do not edit by hand
 % Please edit documentation in R/stage_runner.r
 \name{is.stagerunner}
 \alias{is.stagerunner}

diff --git a/man/is_pre_stagerunner.Rd b/man/is_pre_stagerunner.Rd
@@ -0,0 +1,32 @@
+% Generated by roxygen2 (4.1.0): do not edit by hand
+% Please edit documentation in R/is_pre_stagerunner.R
+\name{is_pre_stagerunner}
+\alias{is_pre_stagerunner}
+\title{Whether or not an object can be transformed into a stageRunner.}
+\usage{
+is_pre_stagerunner(x)
+}
+\arguments{
+\item{x}{ANY. An R object for which it will be determined whether or not
+it admits a conversion to a stageRunner.}
+}
+\value{
+TRUE or FALSE according to whether the object can be transformed
+   to a stageRunner. In general, only a function or list of functions
+   can be turned into a stageRunner.
+}
+\description{
+Whether or not an object can be transformed into a stageRunner.
+}
+\examples{
+stopifnot(is_pre_stagerunner(function(e) { e$x <- 1 }))
+stopifnot(is_pre_stagerunner(list(function(e) { e$x <- 1 }, function(e) { e$y <- 2 })))
+stopifnot(is_pre_stagerunner(
+  list(a = function(e) { e$x <- 1 },
+    list(b = function(e) { e$y <- 2 }, c = function(e) { e$z <- 3 }))))
+
+stopifnot(!is_pre_stagerunner(NULL))
+stopifnot(!is_pre_stagerunner(5))
+stopifnot(!is_pre_stagerunner(iris))
+}
+
diff --git a/man/nested_names.Rd b/man/nested_names.Rd
@@ -1,4 +1,4 @@
-% Generated by roxygen2 (4.1.0.9000): do not edit by hand
+% Generated by roxygen2 (4.1.0): do not edit by hand
 % Please edit documentation in R/nested_names.r
 \name{nested_names}
 \alias{nested_names}

diff --git a/man/normalize_stage_keys.Rd b/man/normalize_stage_keys.Rd
@@ -1,4 +1,4 @@
-% Generated by roxygen2 (4.1.0.9000): do not edit by hand
+% Generated by roxygen2 (4.1.0): do not edit by hand
 % Please edit documentation in R/normalize_stage_keys.r
 \name{normalize_stage_keys}
 \alias{normalize_stage_keys}

diff --git a/man/show_message.Rd b/man/show_message.Rd
@@ -1,4 +1,4 @@
-% Generated by roxygen2 (4.1.0.9000): do not edit by hand
+% Generated by roxygen2 (4.1.0): do not edit by hand
 % Please edit documentation in R/show_message.r
 \name{show_message}
 \alias{show_message}

diff --git a/man/special_and_lists.Rd b/man/special_and_lists.Rd
@@ -1,4 +1,4 @@
-% Generated by roxygen2 (4.1.0.9000): do not edit by hand
+% Generated by roxygen2 (4.1.0): do not edit by hand
 % Please edit documentation in R/special_and_lists.r
 \name{special_and_lists}
 \alias{special_and_lists}

diff --git a/man/special_or_lists.Rd b/man/special_or_lists.Rd
@@ -1,4 +1,4 @@
-% Generated by roxygen2 (4.1.0.9000): do not edit by hand
+% Generated by roxygen2 (4.1.0): do not edit by hand
 % Please edit documentation in R/special_or_lists.r
 \name{special_or_lists}
 \alias{special_or_lists}

diff --git a/man/stageRunner.Rd b/man/stageRunner.Rd
@@ -1,4 +1,4 @@
-% Generated by roxygen2 (4.1.0.9000): do not edit by hand
+% Generated by roxygen2 (4.1.0): do not edit by hand
 % Please edit documentation in R/stage_runner.r
 \name{stageRunner}
 \alias{stageRunner}

diff --git a/man/stageRunnerNode.Rd b/man/stageRunnerNode.Rd
@@ -1,4 +1,4 @@
-% Generated by roxygen2 (4.1.0.9000): do not edit by hand
+% Generated by roxygen2 (4.1.0): do not edit by hand
 % Please edit documentation in R/stage_runner.r
 \docType{class}
 \name{stageRunnerNode}

diff --git a/man/stageRunner__.before_env.Rd b/man/stageRunner__.before_env.Rd
@@ -1,4 +1,4 @@
-% Generated by roxygen2 (4.1.0.9000): do not edit by hand
+% Generated by roxygen2 (4.1.0): do not edit by hand
 % Please edit documentation in R/stage_runner.r
 \name{stageRunner__.before_env}
 \alias{stageRunner__.before_env}

diff --git a/man/stageRunner__.clear_cache.Rd b/man/stageRunner__.clear_cache.Rd
@@ -1,4 +1,4 @@
-% Generated by roxygen2 (4.1.0.9000): do not edit by hand
+% Generated by roxygen2 (4.1.0): do not edit by hand
 % Please edit documentation in R/stage_runner.r
 \name{stageRunner__.clear_cache}
 \alias{stageRunner__.clear_cache}

diff --git a/man/stageRunner__.mark_finished.Rd b/man/stageRunner__.mark_finished.Rd
@@ -1,4 +1,4 @@
-% Generated by roxygen2 (4.1.0.9000): do not edit by hand
+% Generated by roxygen2 (4.1.0): do not edit by hand
 % Please edit documentation in R/stage_runner.r
 \name{stageRunner__.mark_finished}
 \alias{stageRunner__.mark_finished}

diff --git a/man/stageRunner__.root.Rd b/man/stageRunner__.root.Rd
@@ -1,4 +1,4 @@
-% Generated by roxygen2 (4.1.0.9000): do not edit by hand
+% Generated by roxygen2 (4.1.0): do not edit by hand
 % Please edit documentation in R/stage_runner.r
 \name{stageRunner__.root}
 \alias{stageRunner__.root}

diff --git a/man/stageRunner__.set_parents.Rd b/man/stageRunner__.set_parents.Rd
@@ -1,4 +1,4 @@
-% Generated by roxygen2 (4.1.0.9000): do not edit by hand
+% Generated by roxygen2 (4.1.0): do not edit by hand
 % Please edit documentation in R/stage_runner.r
 \name{stageRunner__.set_parents}
 \alias{stageRunner__.set_parents}

diff --git a/man/stageRunner__.set_prefixes.Rd b/man/stageRunner__.set_prefixes.Rd
@@ -1,4 +1,4 @@
-% Generated by roxygen2 (4.1.0.9000): do not edit by hand
+% Generated by roxygen2 (4.1.0): do not edit by hand
 % Please edit documentation in R/objectdiff.R
 \name{stageRunner__.set_prefixes}
 \alias{stageRunner__.set_prefixes}

diff --git a/man/stageRunner__append.Rd b/man/stageRunner__append.Rd
@@ -1,4 +1,4 @@
-% Generated by roxygen2 (4.1.0.9000): do not edit by hand
+% Generated by roxygen2 (4.1.0): do not edit by hand
 % Please edit documentation in R/stage_runner.r
 \name{stageRunner__append}
 \alias{stageRunner__append}

diff --git a/man/stageRunner__around.Rd b/man/stageRunner__around.Rd
@@ -1,4 +1,4 @@
-% Generated by roxygen2 (4.1.0.9000): do not edit by hand
+% Generated by roxygen2 (4.1.0): do not edit by hand
 % Please edit documentation in R/stage_runner.r
 \name{stageRunner__around}
 \alias{stageRunner__around}

diff --git a/man/stageRunner__coalesce.Rd b/man/stageRunner__coalesce.Rd
@@ -1,4 +1,4 @@
-% Generated by roxygen2 (4.1.0.9000): do not edit by hand
+% Generated by roxygen2 (4.1.0): do not edit by hand
 % Please edit documentation in R/stage_runner.r
 \name{stageRunner__coalesce}
 \alias{stageRunner__coalesce}

diff --git a/man/stageRunner__has_key.Rd b/man/stageRunner__has_key.Rd
@@ -1,4 +1,4 @@
-% Generated by roxygen2 (4.1.0.9000): do not edit by hand
+% Generated by roxygen2 (4.1.0): do not edit by hand
 % Please edit documentation in R/stage_runner.r
 \name{stageRunner__has_key}
 \alias{stageRunner__has_key}

diff --git a/man/stageRunner__initialize.Rd b/man/stageRunner__initialize.Rd
@@ -1,4 +1,4 @@
-% Generated by roxygen2 (4.1.0.9000): do not edit by hand
+% Generated by roxygen2 (4.1.0): do not edit by hand
 % Please edit documentation in R/stage_runner.r
 \name{stageRunner__initialize}
 \alias{stageRunner__initialize}

diff --git a/man/stageRunner__next_stage.Rd b/man/stageRunner__next_stage.Rd
@@ -1,4 +1,4 @@
-% Generated by roxygen2 (4.1.0.9000): do not edit by hand
+% Generated by roxygen2 (4.1.0): do not edit by hand
 % Please edit documentation in R/stage_runner.r
 \name{stageRunner__next_stage}
 \alias{stageRunner__next_stage}

diff --git a/man/stageRunner__overlay.Rd b/man/stageRunner__overlay.Rd
@@ -1,4 +1,4 @@
-% Generated by roxygen2 (4.1.0.9000): do not edit by hand
+% Generated by roxygen2 (4.1.0): do not edit by hand
 % Please edit documentation in R/stage_runner.r
 \name{stageRunner__overlay}
 \alias{stageRunner__overlay}

diff --git a/man/stageRunner__run.Rd b/man/stageRunner__run.Rd
@@ -1,4 +1,4 @@
-% Generated by roxygen2 (4.1.0.9000): do not edit by hand
+% Generated by roxygen2 (4.1.0): do not edit by hand
 % Please edit documentation in R/stage_runner.r
 \name{stageRunner__run}
 \alias{stageRunner__run}

diff --git a/man/stageRunner__show.Rd b/man/stageRunner__show.Rd
@@ -1,4 +1,4 @@
-% Generated by roxygen2 (4.1.0.9000): do not edit by hand
+% Generated by roxygen2 (4.1.0): do not edit by hand
 % Please edit documentation in R/stage_runner.r
 \name{stageRunner__show}
 \alias{stageRunner__show}

diff --git a/man/stageRunner__stage_names.Rd b/man/stageRunner__stage_names.Rd
@@ -1,4 +1,4 @@
-% Generated by roxygen2 (4.1.0.9000): do not edit by hand
+% Generated by roxygen2 (4.1.0): do not edit by hand
 % Please edit documentation in R/stage_runner.r
 \name{stageRunner__stage_names}
 \alias{stageRunner__stage_names}

diff --git a/man/stageRunner__transform.Rd b/man/stageRunner__transform.Rd
@@ -1,4 +1,4 @@
-% Generated by roxygen2 (4.1.0.9000): do not edit by hand
+% Generated by roxygen2 (4.1.0): do not edit by hand
 % Please edit documentation in R/stage_runner.r
 \name{stageRunner__transform}
 \alias{stageRunner__transform}

diff --git a/man/treeSkeleton.Rd b/man/treeSkeleton.Rd
@@ -1,4 +1,4 @@
-% Generated by roxygen2 (4.1.0.9000): do not edit by hand
+% Generated by roxygen2 (4.1.0): do not edit by hand
 % Please edit documentation in R/tree_skeleton.r
 \docType{class}
 \name{treeSkeleton}

diff --git a/man/treeSkeleton__.parent_index.Rd b/man/treeSkeleton__.parent_index.Rd
@@ -1,4 +1,4 @@
-% Generated by roxygen2 (4.1.0.9000): do not edit by hand
+% Generated by roxygen2 (4.1.0): do not edit by hand
 % Please edit documentation in R/tree_skeleton.r
 \name{treeSkeleton__.parent_index}
 \alias{treeSkeleton__.parent_index}

diff --git a/man/treeSkeleton__children.Rd b/man/treeSkeleton__children.Rd
@@ -1,4 +1,4 @@
-% Generated by roxygen2 (4.1.0.9000): do not edit by hand
+% Generated by roxygen2 (4.1.0): do not edit by hand
 % Please edit documentation in R/tree_skeleton.r
 \name{treeSkeleton__children}
 \alias{treeSkeleton__children}

diff --git a/man/treeSkeleton__find.Rd b/man/treeSkeleton__find.Rd
@@ -1,4 +1,4 @@
-% Generated by roxygen2 (4.1.0.9000): do not edit by hand
+% Generated by roxygen2 (4.1.0): do not edit by hand
 % Please edit documentation in R/tree_skeleton.r
 \name{treeSkeleton__find}
 \alias{treeSkeleton__find}

diff --git a/man/treeSkeleton__first_leaf.Rd b/man/treeSkeleton__first_leaf.Rd
@@ -1,4 +1,4 @@
-% Generated by roxygen2 (4.1.0.9000): do not edit by hand
+% Generated by roxygen2 (4.1.0): do not edit by hand
 % Please edit documentation in R/tree_skeleton.r
 \name{treeSkeleton__first_leaf}
 \alias{treeSkeleton__first_leaf}

diff --git a/man/treeSkeleton__initialize.Rd b/man/treeSkeleton__initialize.Rd
@@ -1,4 +1,4 @@
-% Generated by roxygen2 (4.1.0.9000): do not edit by hand
+% Generated by roxygen2 (4.1.0): do not edit by hand
 % Please edit documentation in R/tree_skeleton.r
 \name{treeSkeleton__initialize}
 \alias{treeSkeleton__initialize}

diff --git a/man/treeSkeleton__last_leaf.Rd b/man/treeSkeleton__last_leaf.Rd
@@ -1,4 +1,4 @@
-% Generated by roxygen2 (4.1.0.9000): do not edit by hand
+% Generated by roxygen2 (4.1.0): do not edit by hand
 % Please edit documentation in R/tree_skeleton.r
 \name{treeSkeleton__last_leaf}
 \alias{treeSkeleton__last_leaf}

diff --git a/man/treeSkeleton__parent.Rd b/man/treeSkeleton__parent.Rd
@@ -1,4 +1,4 @@
-% Generated by roxygen2 (4.1.0.9000): do not edit by hand
+% Generated by roxygen2 (4.1.0): do not edit by hand
 % Please edit documentation in R/tree_skeleton.r
 \name{treeSkeleton__parent}
 \alias{treeSkeleton__parent}

diff --git a/man/treeSkeleton__root.Rd b/man/treeSkeleton__root.Rd
@@ -1,4 +1,4 @@
-% Generated by roxygen2 (4.1.0.9000): do not edit by hand
+% Generated by roxygen2 (4.1.0): do not edit by hand
 % Please edit documentation in R/tree_skeleton.r
 \name{treeSkeleton__root}
 \alias{treeSkeleton__root}

diff --git a/man/treeSkeleton__successor.Rd b/man/treeSkeleton__successor.Rd
@@ -1,4 +1,4 @@
-% Generated by roxygen2 (4.1.0.9000): do not edit by hand
+% Generated by roxygen2 (4.1.0): do not edit by hand
 % Please edit documentation in R/tree_skeleton.r
 \name{treeSkeleton__successor}
 \alias{treeSkeleton__successor}