File: pkg.R

package info (click to toggle)
r-cran-rsample 0.0.8-1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm, bullseye
  • size: 1,696 kB
  • sloc: sh: 13; makefile: 2
file content (34 lines) | stat: -rw-r--r-- 1,424 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
#' rsample: General Resampling Infrastructure for R
#'
#'\pkg{rsample} has functions to create variations of a data set
#'  that can be used to evaluate models or to estimate the
#'  sampling distribution of some statistic.
#'
#' @section Terminology:
#'\itemize{
#'  \item A **resample** is the result of a two-way split of a
#'  data set. For example, when bootstrapping, one part of the
#'  resample is a sample with replacement of the original data.
#'  The other part of the split contains the instances that were
#'  not contained in the bootstrap sample. The data structure
#'  `rsplit` is used to store a single resample. 
#'  \item When the data are split in two, the portion that is
#'  used to estimate the model or calculate the statistic is
#'  called the **analysis** set here. In machine learning this
#'  is sometimes called the "training set" but this would be
#'  poorly named since it might conflict with any initial split
#'  of the original data.
#'  \item Conversely, the other data in the split are called the
#'     **assessment** data. In bootstrapping, these data are
#'     often called the "out-of-bag" samples. 
#'  \item A collection of resamples is contained in an 
#'  `rset` object.
#'}
#'
#' @section Basic Functions:
#' The main resampling functions are: [vfold_cv()], 
#'   [bootstraps()], [mc_cv()], 
#'   [rolling_origin()], and [nested_cv()].
#' @docType package
#' @name rsample
NULL