Merge pull request #64 from mayer79/cran_submission

CRAN submission ready

CRAN-SUBMISSION

@@ -1,3 +1,3 @@
-Version: 0.2.0
-Date: 2023-09-03 16:23:41 UTC
-SHA: 9fb4db1361c4593b956fb65fd122ed49d1b01caa
+Version: 0.3.0
+Date: 2023-09-29 11:29:11 UTC
+SHA: f2f2aa7b74b3e3d8adfb237b7e75db63faf5ca13

NEWS.md

@@ -1,5 +1,7 @@
 # hstats 0.3.0
 
+This is intended to be the last version before 1.0.0.
+
 ## Visible changes
 
 - Grid of `ice()` and `partial_dep()`: So far, the default grid strategy "uniform" used `pretty()` to generate the evaluation points. To provide more predictable grid sizes, and to be more in line with other implementations of partial dependence and ICE, we now use `seq()` to create the uniform grid.

R/hstats.R

@@ -27,9 +27,9 @@
 #' @param pred_fun Prediction function of the form `function(object, X, ...)`,
 #'   providing \eqn{K \ge 1} predictions per row. Its first argument represents the 
 #'   model `object`, its second argument a data structure like `X`. Additional arguments 
-#'   (such as `type = "response"` in a GLM) can be passed via `...`. The default, 
-#'   [stats::predict()], will work in most cases. Note that column names in a resulting
-#'   matrix of predictions will be used as default column names in the results.
+#'   (such as `type = "response"` in a GLM, or `reshape = TRUE` in a multiclass XGBoost
+#'   model) can be passed via `...`. The default, [stats::predict()], will work in 
+#'   most cases.
 #' @param n_max If `X` has more than `n_max` rows, a random sample of `n_max` rows is
 #'   selected from `X`. In this case, set a random seed for reproducibility.
 #' @param w Optional vector of case weights for each row of `X`.

R/partial_dep.R

@@ -2,7 +2,7 @@
 #' 
 #' Estimates the partial dependence function of feature(s) `v` over a 
 #' grid of values. Both multivariate and multivariable situations are supported.
-#' By default, the resulting values are plotted.
+#' The resulting object can be plotted via `plot()`.
 #' 
 #' @section Partial Dependence Functions: 
 #' 

cran-comments.md

@@ -1,10 +1,8 @@
-# hstats 0.2.0
+# hstats 0.3.0
 
-Hello CRAN team
+Dear CRAN team
 
-{hstats} received a fast, multivariate permutation importance function, and some API improvements. Not yet ready for version 1.0.0, but almost :-).
-
-Thanks a lot for caring about R so much
+{hstats} is now one step away from stable version 1.0.0.
 
 Michael