An open API service indexing awesome lists of open source software.

https://github.com/hsbadr/additive

Bindings for Additive TidyModels
https://github.com/hsbadr/additive

additive bam gam generalized-additive-models mgcv r tidymodels

Last synced: 4 months ago
JSON representation

Bindings for Additive TidyModels

Awesome Lists containing this project

README

          

---
output: github_document
---

```{r, include = FALSE}
knitr::opts_chunk$set(
collapse = TRUE,
comment = "#>",
fig.path = "man/figures/README-",
out.width = "100%"
)
```

# Bindings for Additive TidyModels [additive logo](https://hsbadr.github.io/additive/)

[![Lifecycle: Stable](https://img.shields.io/badge/Lifecycle-Stable-green.svg)](https://lifecycle.r-lib.org/articles/stages.html)
[![Codecov Test Coverage](https://codecov.io/gh/hsbadr/additive/branch/main/graph/badge.svg)](https://app.codecov.io/gh/hsbadr/additive?branch=main)
[![Last commit](https://img.shields.io/github/last-commit/hsbadr/additive)](https://github.com/hsbadr/additive/commits/main)
[![Commits since release](https://img.shields.io/github/commits-since/hsbadr/additive/latest.svg?color=green)](https://github.com/hsbadr/additive/commit/main)
[![R](https://github.com/hsbadr/additive/workflows/R/badge.svg)](https://github.com/hsbadr/additive/actions)

[![CRAN Status](https://www.r-pkg.org/badges/version/additive)](https://CRAN.R-project.org/package=additive)
[![CRAN Downloads](https://cranlogs.r-pkg.org/badges/grand-total/additive)](https://cran.r-project.org/package=additive)
[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://github.com/hsbadr/additive/blob/main/LICENSE.md)
[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.4784245.svg)](https://zenodo.org/records/4784245)

[**`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/).