Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/tidymodels/rsample
Classes and functions to create and summarize resampling objects
https://github.com/tidymodels/rsample
Last synced: 3 days ago
JSON representation
Classes and functions to create and summarize resampling objects
- Host: GitHub
- URL: https://github.com/tidymodels/rsample
- Owner: tidymodels
- License: other
- Created: 2017-04-22T19:19:58.000Z (over 7 years ago)
- Default Branch: main
- Last Pushed: 2024-05-22T10:05:44.000Z (6 months ago)
- Last Synced: 2024-05-22T13:32:03.377Z (6 months ago)
- Language: R
- Homepage: https://rsample.tidymodels.org
- Size: 25.5 MB
- Stars: 324
- Watchers: 25
- Forks: 57
- Open Issues: 35
-
Metadata Files:
- Readme: README.Rmd
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE
- Code of conduct: .github/CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
- jimsghstars - tidymodels/rsample - Classes and functions to create and summarize resampling objects (R)
README
---
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%"
)
```[![R-CMD-check](https://github.com/tidymodels/rsample/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/tidymodels/rsample/actions/workflows/R-CMD-check.yaml)
[![Codecov test coverage](https://codecov.io/gh/tidymodels/rsample/branch/main/graph/badge.svg)](https://app.codecov.io/gh/tidymodels/rsample?branch=main)
[![CRAN_Status_Badge](https://www.r-pkg.org/badges/version/rsample)](https://cran.r-project.org/package=rsample)
[![Downloads](https://cranlogs.r-pkg.org/badges/rsample)](https://cran.r-project.org/package=rsample)
[![lifecycle](https://img.shields.io/badge/lifecycle-stable-brightgreen.svg)](https://lifecycle.r-lib.org/articles/stages.html)## 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 Bset.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
```Created on 2022-02-28 by the [reprex package](https://reprex.tidyverse.org) (v2.0.1)
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/).