-
Notifications
You must be signed in to change notification settings - Fork 1
/
README.Rmd
94 lines (65 loc) · 3.71 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
---
<!-- 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%"
)
```
# Bindings for Additive TidyModels [<img src="man/figures/additive.png" align="right" width="160" alt="additive logo" />](https://hsbadr.github.io/additive/)
<!-- badges: start -->
[](https://lifecycle.r-lib.org/articles/stages.html)
[](https://app.codecov.io/gh/hsbadr/additive?branch=main)
[](https://github.com/hsbadr/additive/commits/main)
[](https://github.com/hsbadr/additive/commit/main)
[](https://github.com/hsbadr/additive/actions)
[](https://CRAN.R-project.org/package=additive)
[](https://cran.r-project.org/package=additive)
[](https://github.com/hsbadr/additive/blob/main/LICENSE.md)
[](https://zenodo.org/records/4784245)
<!-- badges: end -->
[**`additive`**](https://hsbadr.github.io/additive/) supports Generalized Additive Models (GAM) using [`mgcv`](https://cran.r-project.org/package=mgcv)
with [`parsnip`](https://parsnip.tidymodels.org/)/[`tidymodels`](https://www.tidymodels.org/).
## Installation
The stable version of [`additive`](https://hsbadr.github.io/additive/) can be installed from [CRAN](https://CRAN.R-project.org/package=additive) using:
``` r
install.packages("additive")
```
The development version of [`additive`](https://hsbadr.github.io/additive/) can be installed from [GitHub](https://github.com/hsbadr/additive) using:
``` r
install.packages("pak")
pak::pkg_install("hsbadr/additive")
```
## Example
``` r
library(additive)
set.seed(2020)
dat <- gamSim(1, n = 400, dist = "normal", scale = 2)
additive_mod <-
additive() |>
set_engine("mgcv") |>
fit(
y ~ s(x0) + s(x1) + s(x2) + s(x3),
data = dat
)
summary(additive_mod$fit)
```
For more details, [get started with `additive`](https://hsbadr.github.io/additive/articles/GetStarted.html).
## Citation
To cite `additive` in publications, please use:
```r
citation("additive")
```
> Hamada S. Badr (2024): additive: Bindings for Additive TidyModels,
> [*Comprehensive R Archive Network (CRAN)*](https://cran.r-project.org/package=additive).
> URL: [https://hsbadr.github.io/additive/](https://hsbadr.github.io/additive/).
## 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/).
- If you think you have encountered a bug, please [submit an issue](https://github.com/hsbadr/additive/issues).
- Either way, learn how to create and share a [reprex](https://reprex.tidyverse.org) (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/).