R/pkg.R

In edwindj/chunked: Chunkwise Text-File Processing for 'dplyr'

#' Chunked
#'
#' R is a great tool, but processing large text files with data is cumbersome.
#' \code{chunked} helps you to process large text files with dplyr while loading
#' only a part of the data in memory. It builds on the execellent R package LaF
#' Processing commands are writing in dplyr syntax, and \code{chunked}
#'  (using \code{LaF})
#'  will take care that chunk by chunk is processed, taking far less memory
#'  than otherwise. \code{chunked} is useful for selecting columns, mutating columns
#'  and filtering rows. It can be used in data pre-processing.
#'
#' @section Implemented dplyr verbs:
#'
#' \itemize{
#'  \item filter
#'  \item select
#'  \item rename
#'  \item mutate
#'  \item transmute
#'  \item do
#'  \item left_join
#'  \item inner_join
#'  \item anti_join
#'  \item semi_join
#'  \item tbl_vars
#'  \item collect
#' }
#'
#' filter, select, do, left_join, inner_join
#'
#' @section Not implemented:
#'
#'  The following operators are not implemented because data in \code{chunked} is processed
#'  chunkwise, so these are not available.
#'  \itemize{
#'   \item full_join
#'   \item right_join
#'   \item group_by
#'   \item arrange
#'   \item tail
#'  }
#'
#'
#'
#' @docType package
#' @name chunked-package
#' @aliases select filter mutate dplyr-verbs
NULL