From 445906e2aaacf68b059abf77ac36c3d29e2a5722 Mon Sep 17 00:00:00 2001 From: Kelly Sovacool Date: Sat, 29 Jan 2022 10:39:43 -0500 Subject: [PATCH 1/2] Prepare to release v1.2.1 --- DESCRIPTION | 4 ++-- NEWS.md | 4 ++-- cran-comments.md | 2 +- 3 files changed, 5 insertions(+), 5 deletions(-) diff --git a/DESCRIPTION b/DESCRIPTION index 23e9e029..59905770 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -1,7 +1,7 @@ Package: mikropml Title: User-Friendly R Package for Supervised Machine Learning Pipelines -Version: 1.2.0.9000 -Date: 2021-11-10 +Version: 1.2.1 +Date: 2022-01-29 Authors@R: c(person(given = "Begüm", family = "Topçuoğlu", diff --git a/NEWS.md b/NEWS.md index 6f23ac00..22b39140 100644 --- a/NEWS.md +++ b/NEWS.md @@ -1,8 +1,8 @@ -# development version 1.3.0 +# mikropml 1.2.1 - Allow `kfold >= length(groups)` (#285, @kelly-sovacool). - When using the groups parameter, groups are kept together in cross-validation partitions when `kfold` <= the number of groups in the training set. Previously, an error was thrown if this condition was not met. Now, if there are not enough groups in the training set for groups to be kept together during CV, groups are allowed to be split up across CV partitions. -- Report p-values for permutation feature importance (#288, @kelly-sovacool) +- Report p-values for permutation feature importance (#288, @kelly-sovacool). # mikropml 1.2.0 diff --git a/cran-comments.md b/cran-comments.md index 99718375..fafab4e8 100644 --- a/cran-comments.md +++ b/cran-comments.md @@ -17,7 +17,7 @@ Message: Bad Request ``` -I believe this is a spurious note as the URL works in my local browser. +This is a spurious note as the URL works in my local browser. ## revdepcheck results From 3b0be13b97e8cf1de7ce0f8668f1297f62b5ab13 Mon Sep 17 00:00:00 2001 From: Kelly Sovacool Date: Sat, 29 Jan 2022 11:06:29 -0500 Subject: [PATCH 2/2] Don't export keep_groups_in_cv_partitions() --- NAMESPACE | 1 - R/cross_val.R | 2 +- man/keep_groups_in_cv_partitions.Rd | 36 ----------------------------- 3 files changed, 1 insertion(+), 38 deletions(-) delete mode 100644 man/keep_groups_in_cv_partitions.Rd diff --git a/NAMESPACE b/NAMESPACE index 9ae3ed28..81dd1dd4 100644 --- a/NAMESPACE +++ b/NAMESPACE @@ -19,7 +19,6 @@ export(get_perf_metric_name) export(get_performance_tbl) export(get_tuning_grid) export(group_correlated_features) -export(keep_groups_in_cv_partitions) export(plot_hp_performance) export(plot_model_performance) export(preprocess_data) diff --git a/R/cross_val.R b/R/cross_val.R index 4b1ff605..f1c4f535 100644 --- a/R/cross_val.R +++ b/R/cross_val.R @@ -93,7 +93,7 @@ get_seeds_trainControl <- function(hyperparams_list, kfold, cv_times, ncol_train #' @inheritParams define_cv #' #' @return `TRUE` if possible, `FALSE` otherwise -#' @export +#' @noRd #' @author Kelly Sovacool, \email{sovacool@@umich.edu} #' keep_groups_in_cv_partitions <- function(groups, group_partitions, kfold) { diff --git a/man/keep_groups_in_cv_partitions.Rd b/man/keep_groups_in_cv_partitions.Rd deleted file mode 100644 index c54254d3..00000000 --- a/man/keep_groups_in_cv_partitions.Rd +++ /dev/null @@ -1,36 +0,0 @@ -% Generated by roxygen2: do not edit by hand -% Please edit documentation in R/cross_val.R -\name{keep_groups_in_cv_partitions} -\alias{keep_groups_in_cv_partitions} -\title{Whether groups can be kept together in partitions during cross-validation} -\usage{ -keep_groups_in_cv_partitions(groups, group_partitions, kfold) -} -\arguments{ -\item{groups}{Vector of groups to keep together when splitting the data into -train and test sets. If the number of groups in the training set is larger -than \code{kfold}, the groups will also be kept together for cross-validation. -Length matches the number of rows in the dataset (default: \code{NULL}).} - -\item{group_partitions}{Specify how to assign \code{groups} to the training and -testing partitions (default: \code{NULL}). If \code{groups} specifies that some -samples belong to group \code{"A"} and some belong to group \code{"B"}, then setting -\code{group_partitions = list(train = c("A", "B"), test = c("B"))} will result -in all samples from group \code{"A"} being placed in the training set, some -samples from \code{"B"} also in the training set, and the remaining samples from -\code{"B"} in the testing set. The partition sizes will be as close to -\code{training_frac} as possible. If the number of groups in the training set is -larger than \code{kfold}, the groups will also be kept together for -cross-validation.} - -\item{kfold}{Fold number for k-fold cross-validation (default: \code{5}).} -} -\value{ -\code{TRUE} if possible, \code{FALSE} otherwise -} -\description{ -Whether groups can be kept together in partitions during cross-validation -} -\author{ -Kelly Sovacool, \email{sovacool@umich.edu} -}