R/group-helpers.R

In adibender/pamm: Functions and Utilities for fitting Piece-wise Exponential (Additive) models

#' Extract character vector of grouping variables
#'
#' @importFrom dplyr groups
#' @param data A data frame (potentially `grouped_df`) from which to extract
#' names of grouping variables.
#' @return A character vector (of length 0 if no grouping variables present).
#' @keywords internal
get_grpvars <- function(data) {
  vapply(groups(data), as.character, character(1))
}

#' Return ungrouped data frame without grouping variables
#'
#' @param data A data frame (potentially `grouped_df`) from which grouping
#' variables will be removed.
#' @import dplyr
#' @return Returns \code{data} without grouping variables (and group properties).
#' @keywords internal
rm_grpvars <- function(data) {

  if(is.grouped_df(data)) {
    grp.vars <- get_grpvars(data)
    data %<>% ungroup() %>% select(-one_of(grp.vars))
  }
  return(data)

}