R/AllClasses.R

In Crunch-io/crplyr: A 'dplyr' Interface for Crunch

#' A Crunch Dataset "Grouped By" Something
#'
#' This is a subclass of `crunch::CrunchDataset` that has a field for recording
#' "group_by" expressions.
#'
#' @export
#' @importFrom methods new
#' @importClassesFrom crunch CrunchDataset
#' @examples
#' \dontrun{
#' ds <- loadDataset("Your dataset name")
#' class(ds) ## "CrunchDataset"
#' grouped_ds <- group_by(ds, var1)
#' class(grouped_ds) ## "GroupedCrunchDataset"
#' }
GroupedCrunchDataset <- setClass("GroupedCrunchDataset",
    contains="CrunchDataset",
    slots=c(groupBy="list"))