forked from tidymodels/rsample
-
Notifications
You must be signed in to change notification settings - Fork 0
/
README.Rmd
95 lines (64 loc) · 3.8 KB
/
README.Rmd
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
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
---
output: github_document
editor_options:
chunk_output_type: console
---
```{r, include = FALSE}
knitr::opts_chunk$set(
collapse = TRUE,
comment = "#>",
fig.path = "man/figures/README-",
out.width = "100%"
)
```
# rsample <a href='https://rsample.tidymodels.org/'><img src='man/figures/logo.png' align="right" height="139" alt="a boot on a green background" /></a>
<!-- badges: start -->
[](https://github.com/tidymodels/rsample/actions/workflows/R-CMD-check.yaml)
[](https://app.codecov.io/gh/tidymodels/rsample?branch=main)
[](https://cran.r-project.org/package=rsample)
[](https://cran.r-project.org/package=rsample)
[](https://lifecycle.r-lib.org/articles/stages.html)
<!-- badges: end -->
## Overview
The rsample package provides functions to create different types of resamples and corresponding classes for their analysis.
The goal is to have a modular set of methods that can be used for:
* resampling for estimating the sampling distribution of a statistic
* estimating model performance using a holdout set
The scope of rsample is to provide the basic building blocks for creating and analyzing resamples of a data set, but this package does not include code for modeling or calculating statistics. The [Working with Resample Sets](https://rsample.tidymodels.org/articles/Working_with_rsets.html) vignette gives a demonstration of how rsample tools can be used when building models.
Note that resampled data sets created by rsample are directly accessible in a resampling object but do not contain much overhead in memory. Since the original data is not modified, R does not make an automatic copy.
For example, creating 50 bootstraps of a data set does not create an object that is 50-fold larger in memory:
``` r
library(rsample)
library(mlbench)
data(LetterRecognition)
lobstr::obj_size(LetterRecognition)
#> 2,644,640 B
set.seed(35222)
boots <- bootstraps(LetterRecognition, times = 50)
lobstr::obj_size(boots)
#> 6,686,776 B
# Object size per resample
lobstr::obj_size(boots)/nrow(boots)
#> 133,735.5 B
# Fold increase is <<< 50
as.numeric(lobstr::obj_size(boots)/lobstr::obj_size(LetterRecognition))
#> [1] 2.528426
```
<sup>Created on 2022-02-28 by the [reprex package](https://reprex.tidyverse.org) (v2.0.1)</sup>
The memory usage for 50 bootstrap samples is less than 3-fold more than the original data set.
## Installation
To install it, use:
```{r install, eval = FALSE}
install.packages("rsample")
```
And the development version from [GitHub](https://github.com/) with:
``` r
# install.packages("pak")
pak::pak("rsample")
```
## Contributing
This project is released with a [Contributor Code of Conduct](https://contributor-covenant.org/version/2/1/CODE_OF_CONDUCT.html). By contributing to this project, you agree to abide by its terms.
- For questions and discussions about tidymodels packages, modeling, and machine learning, please [post on Posit Community](https://forum.posit.co/new-topic?category_id=15&tags=tidymodels,question).
- If you think you have encountered a bug, please [submit an issue](https://github.com/tidymodels/rsample/issues).
- Either way, learn how to create and share a [reprex](https://reprex.tidyverse.org/articles/articles/learn-reprex.html) (a minimal, reproducible example), to clearly communicate about your code.
- Check out further details on [contributing guidelines for tidymodels packages](https://www.tidymodels.org/contribute/) and [how to get help](https://www.tidymodels.org/help/).