From 003ea4fbcd8520b82b97d639f878391a07100a39 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Benno=20Pu=CC=88tz?= <puetz@psych.mpg.de>
Date: Fri, 11 Aug 2017 19:21:50 +0200
Subject: [PATCH] documented "matlike" option

---
 vcomb.R | 5 ++++-
 1 file changed, 4 insertions(+), 1 deletion(-)

diff --git a/vcomb.R b/vcomb.R
index 1cef158..1d3bcd0 100644
--- a/vcomb.R
+++ b/vcomb.R
@@ -15,6 +15,9 @@
 ##' @param v1 first vector
 ##' @param v2 second vector
 ##' @param myfun function to combine the element pairs from the two vectors
+##' @param matlike return in format similar to \code{outer}, i.e., the first
+##'                two dimensions reflect the vectors lengths, additional
+##'                dimensions are added when \code{myfun} has non-scalar output
 ##' @param ... not used
 ##' @return vector (or matrix, array) of combinations
 ##' @author Benno Puetz \email{puetz@@mpipsykl.mpg.de}
@@ -57,7 +60,7 @@ vcomb <- function(v1, v2,
               ## matrix or array from myfun
               dim(retval) <- c(length(v1), length(v2), rd)
             }
-            
+
         }
     }
     return(retval)