-
Notifications
You must be signed in to change notification settings - Fork 17
/
README.Rmd
86 lines (54 loc) · 4.33 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
---
output: github_document
editor_options:
chunk_output_type: console
---
<!-- README.md is generated from README.Rmd. Please edit that file -->
```{r, include = FALSE}
knitr::opts_chunk$set(
collapse = TRUE,
comment = "#>",
fig.path = "man/figures/README-",
out.width = "100%"
)
options(rlang__backtrace_on_error = "reminder")
```
# hardhat <a href="https://hardhat.tidymodels.org"><img src="man/figures/logo.png" align="right" height="138"/></a>
<!-- badges: start -->
[](https://app.codecov.io/gh/tidymodels/hardhat?branch=main)
[](https://github.com/tidymodels/hardhat/actions/workflows/R-CMD-check.yaml)
[](https://github.com/tidymodels/hardhat/actions/workflows/R-CMD-check-hard.yaml)
<!-- badges: end -->
## Introduction
hardhat is a *developer focused* package designed to ease the creation of new modeling packages, while simultaneously promoting good R modeling package standards as laid out by the set of opinionated [Conventions for R Modeling Packages](https://tidymodels.github.io/model-implementation-principles/).
hardhat has four main goals:
- Easily, consistently, and robustly preprocess data at fit time and prediction time with `mold()` and `forge()`.
- Provide one source of truth for common input validation functions, such as checking if new data at prediction time contains the same required columns used at fit time.
- Provide extra utility functions for additional common tasks, such as adding intercept columns, standardizing `predict()` output, and extracting valuable class and factor level information from the predictors.
- Reimagine the base R preprocessing infrastructure of `stats::model.matrix()` and `stats::model.frame()` using the stricter approaches found in `model_matrix()` and `model_frame()`.
The idea is to reduce the burden of creating a good modeling interface as much as possible, and instead let the package developer focus on writing the core implementation of their new model.
This benefits not only the developer, but also the user of the modeling package, as the standardization allows users to build a set of "expectations" around what any modeling function should return, and how they should interact with it.
## Installation
You can install the released version of hardhat from [CRAN](https://CRAN.R-project.org) with:
``` r
install.packages("hardhat")
```
And the development version from [GitHub](https://github.com/) with:
``` r
# install.packages("pak")
pak::pak("tidymodels/hardhat")
```
## Learning more
To learn about how to use hardhat, check out the vignettes:
- `vignette("mold", "hardhat")`: Learn how to preprocess data at fit time with `mold()`.
- `vignette("forge", "hardhat")`: Learn how to preprocess new data at prediction time with `forge()`.
- `vignette("package", "hardhat")`: Learn how to use `mold()` and `forge()` to help in creating a new modeling package.
You can also watch [Max Kuhn](https://github.com/topepo) discuss how to use hardhat to build a new modeling package from scratch at the XI Jornadas de Usuarios de R conference [here](https://canal.uned.es/video/5dd25b9f5578f275e407dd88).
[](https://canal.uned.es/video/5dd25b9f5578f275e407dd88)
## Contributing
This project is released with a [Contributor Code of Conduct](https://contributor-covenant.org/version/2/0/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 RStudio 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/hardhat/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/).