More natural examples in readme

Author: mayer79

R/permshap.R

@@ -1,7 +1,7 @@
 #' Permutation SHAP
 #'
-#' Exact permutation SHAP values with respect to a background dataset.
-#' The function is currently limited to maximum 14 features.
+#' Exact permutation SHAP algorithm with respect to a background dataset,
+#' see Strumbelj and Kononenko. The function works for up to 14 features.
 #'
 #' @inheritParams kernelshap
 #' @returns
@@ -16,6 +16,9 @@
 #'     (currently `TRUE`).
 #'   - `txt`: Summary text.
 #'   - `predictions`: \eqn{(n \times K)} matrix with predictions of `X`.
+#' @references
+#'   1. Erik Strumbelj and Igor Kononenko. Explaining prediction models and individual 
+#'     predictions with feature contributions. Knowledge and Information Systems 41, 2014.
 #' @export
 #' @examples
 #' # MODEL ONE: Linear regression