Merge pull request #110 from shawntz/89-preprocessing-parameters-in-o…

…utput-report

feature #89: preprocessing parameters in output report

R/handlers.R

@@ -8,6 +8,14 @@ error_handler <- function(e, e_class) {
 
 # generic handler/wrapper for eyeris pupil pipeline funcs
 pipeline_handler <- function(eyeris, operation, new_suffix, ...) {
+  call_stack <- sys.calls()[[1]]
+
+  if (!is.list(eyeris$params)) {
+    eyeris$params <- list()
+  }
+
+  eyeris$params[[new_suffix]] <- call_stack
+
   tryCatch(
     {
       check_data(eyeris, new_suffix)

R/parsers.R

@@ -0,0 +1,22 @@
+parse_call_stack <- function(call_str) {
+  func <- sub("\\(.*", "", call_str)
+  return(list(Function = func, Arguments = call_str))
+}
+
+format_call_stack <- function(callstack) {
+  params_parsed <- do.call(rbind, lapply(names(callstack), function(step) {
+    parsed <- parse_call_stack(callstack[[step]])
+    args <- deparse(parsed$Arguments)
+    args <- paste(args, collapse = "")
+
+    data.frame(
+      step = step,
+      callstack = args,
+      stringsAsFactors = FALSE
+    )
+  }))
+
+  rownames(params_parsed) <- NULL
+
+  return(params_parsed)
+}

R/report.R

@@ -46,6 +46,9 @@ make_report <- function(eyeris, out, plots, ...) {
     "\n\n---\n\n## EyeLink Header Metadata\n\n",
     make_md_table(eyeris$info), "\n",
 
+    "\n\n---\n\n## eyeris call stack\n\n",
+    make_md_table(format_call_stack(eyeris$params)), "\n",
+
     "\n\n---\n\n### Citation\n\n",
     "```{r citation, echo=FALSE, comment=NA}\n",
     "citation('eyeris')\n",