Merge pull request #60 from mayer79/docu_fix

Clearer documentation of grid arguments

R/grid.R

@@ -1,14 +1,14 @@
 #' Univariate Grid
 #' 
 #' @description
-#' Finds evaluation grid for any numeric or non-numeric vector `z`. 
+#' Creates evaluation grid for any numeric or non-numeric vector `z`. 
 #' 
 #' For discrete `z` (non-numeric, or numeric with at most `grid_size` unique values), 
 #' this is simply `sort(unique(z))`.
 #' 
 #' Otherwise, if `strategy = "uniform"` (default), the evaluation points form a regular
 #' grid over the trimmed range of `z`. By trimmed range we mean the
-#' range of `z` after removing values outside the `trim[1]` and `trim[2]` quantiles.
+#' range of `z` after removing values outside `trim[1]` and `trim[2]` quantiles.
 #' Set `trim = 0:1` for no trimming.
 #' 
 #' If `strategy = "quantile"`, the evaluation points are quantiles over a regular grid 
@@ -20,11 +20,11 @@
 #' @param z A vector or factor.
 #' @param grid_size Approximate grid size.
 #' @param trim The default `c(0.01, 0.99)` means that values outside the 
-#'   1% and 99% quantile of a non-discrete numeric `z` are removed before calculating 
-#'   the grid values. Set to `0:1` for no trimming.
-#' @param strategy How to find evaluation points of non-discrete numeric columns? 
+#'   1% and 99% quantiles of non-discrete numeric columns are removed before calculation 
+#'   of grid values. Set to `0:1` for no trimming.
+#' @param strategy How to find grid values of non-discrete numeric columns? 
 #'   Either "uniform" or "quantile", see description of [univariate_grid()].
-#' @returns A vector/factor of evaluation points.
+#' @returns A vector or factor of evaluation points.
 #' @seealso [multivariate_grid()]
 #' @export
 #' @examples

R/partial_dep.R

@@ -31,8 +31,8 @@
 #' 
 #' @inheritParams hstats
 #' @inheritParams multivariate_grid
-#' @param grid A vector (if `length(v) == 1L`), or a matrix/data.frame otherwise.
-#'   If `NULL`, calculated via [multivariate_grid()].
+#' @param grid Evaluation grid. A vector (if `length(v) == 1L`), or a matrix/data.frame 
+#'   otherwise. If `NULL`, calculated via [multivariate_grid()].
 #' @param BY Optional grouping vector or a column name. The partial dependence
 #'   function is calculated per `BY` group. Each `BY` group
 #'   uses the same evaluation grid to improve assessment of (non-)additivity.