R-splitters: Creating Groups from Data

#' groupdata2: A package for creating groups from data
#'
#' Methods for dividing data into groups.
#' Create balanced partitions and cross-validation folds.
#' Perform time series windowing and general grouping and splitting of data.
#' Balance existing groups with up- and downsampling.
#'
#' The \code{groupdata2} package provides six main functions:
#' \code{group()}, \code{group_factor()}, \code{splt()}, \code{partition()},
#' \code{fold()}, and \code{balance()}.
#'
#' @section group:
#' Create groups from your data.
#'
#' Divides data into groups by a wide range of methods.
#' Creates a grouping factor with \code{1}s for group 1, \code{2}s for group 2, etc.
#' Returns a \code{data.frame} grouped by the grouping factor
#' for easy use in \code{magrittr} pipelines.
#'
#' Go to \code{\link{group}()}
#'
#' @section group_factor:
#' Create grouping factor for subsetting your data.
#'
#' Divides data into groups by a wide range of methods.
#' Creates and returns a grouping factor
#' with \code{1}s for group 1, \code{2}s for group 2, etc.
#'
#' Go to \code{\link{group_factor}()}
#'
#' @section splt:
#' Split data by a wide range of methods.
#'
#' Divides data into groups by a wide range of methods.
#' Splits data by these groups.
#'
#' Go to \code{\link{splt}()}
#'
#' @section partition:
#' Create balanced partitions (e.g. training/test sets).
#'
#' Splits data into partitions.
#' Balances a given categorical variable between partitions
#' and keeps (if possible) all data points with a shared ID
#' (e.g. participant_id) in the same partition.
#'
#' Go to \code{\link{partition}()}
#'
#' @section fold:
#' Create balanced folds for cross-validation.
#'
#' Divides data into groups (folds) by a wide range of methods.
#' Balances a given categorical variable between folds and keeps (if possible)
#' all data points with the same ID (e.g. participant_id) in the same fold.
#'
#' Go to \code{\link{fold}()}
#'
#' @section balance:
#' Balance the sizes of your groups with up- and downsampling.
#'
#' Uses up- and/or downsampling to fix the group sizes to the
#'  \code{min}, \code{max}, \code{mean}, or \code{median} group size or
#'  to a specific number of rows. Has a set of methods for balancing on
#'  ID level.
#'
#' Go to \code{\link{balance}()}
#' @author Ludvig Renbo Olsen, \email{r-pkgs@@ludvigolsen.dk}
"_PACKAGE"



# Never used, but removes R CMD check NOTEs
rcmd_import_handler <- function(){
  lifecycle::deprecate_soft()
}