additive

Bindings for Additive TidyModels

https://github.com/hsbadr/additive

Keywords

additive bam gam generalized-additive-models mgcv r tidymodels

Last synced: 6 months ago · JSON representation ·

Repository

Bindings for Additive TidyModels

Basic Info

Host: GitHub
Owner: hsbadr
License: other
Language: R
Default Branch: main
Homepage: https://hsbadr.github.io/additive/
Size: 8.45 MB

Statistics

Stars: 7
Watchers: 2
Forks: 2
Open Issues: 0
Releases: 0

Topics

additive bam gam generalized-additive-models mgcv r tidymodels

Created almost 5 years ago · Last pushed 6 months ago

Metadata Files

Readme Changelog Contributing License Code of conduct Citation Support

README.Rmd

---
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 [](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/).

Owner

Name: Hamada S. Badr
Login: hsbadr
Kind: user
Location: Washington, District of Columbia
Company: Amazon Web Services (AWS)

Website: https://hsbadr.github.io
Repositories: 29
Profile: https://github.com/hsbadr

Senior Applied Scientist

Citation (CITATION.cff)

# --------------------------------------------
# CITATION file created with {cffr} R package
# See also: https://docs.ropensci.org/cffr/
# --------------------------------------------
 
cff-version: 1.2.0
message: 'To cite package "additive" in publications use:'
type: software
license: MIT
title: 'additive: Bindings for Additive TidyModels'
version: 1.0.1
doi: 10.5281/zenodo.4784245
identifiers:
- type: doi
  value: 10.32614/CRAN.package.additive
abstract: Fit Generalized Additive Models (GAM) using 'mgcv' with 'parsnip'/'tidymodels'
  via 'additive' <https://doi.org/10.5281/zenodo.4784245>. 'tidymodels' is a collection
  of packages for machine learning; see Kuhn and Wickham (2020) <https://www.tidymodels.org>).
  The technical details of 'mgcv' are described in Wood (2017) <https://doi.org/10.1201/9781315370279>.
authors:
- family-names: Badr
  given-names: Hamada S.
  email: badr@jhu.edu
  orcid: https://orcid.org/0000-0002-9808-2344
preferred-citation:
  type: manual
  title: 'additive: Bindings for Additive TidyModels'
  authors:
  - family-names: Badr
    given-names: Hamada S.
    email: badr@jhu.edu
    orcid: https://orcid.org/0000-0002-9808-2344
  year: '2024'
  journal: Comprehensive R Archive Network (CRAN)
  url: https://hsbadr.github.io/additive/
  doi: 10.5281/zenodo.4784245
repository: https://CRAN.R-project.org/package=additive
repository-code: https://github.com/hsbadr/additive
url: https://hsbadr.github.io/additive/
contact:
- family-names: Badr
  given-names: Hamada S.
  email: badr@jhu.edu
  orcid: https://orcid.org/0000-0002-9808-2344
keywords:
- additive
- bam
- gam
- generalized-additive-models
- mgcv
- r
- tidymodels
references:
- type: software
  title: mgcv
  abstract: 'mgcv: Mixed GAM Computation Vehicle with Automatic Smoothness Estimation'
  notes: Depends
  repository: https://CRAN.R-project.org/package=mgcv
  authors:
  - family-names: Wood
    given-names: Simon
    email: simon.wood@r-project.org
  year: '2025'
  doi: 10.32614/CRAN.package.mgcv
  version: '>= 1.9-1'
- type: software
  title: parsnip
  abstract: 'parsnip: A Common API to Modeling and Analysis Functions'
  notes: Depends
  url: https://parsnip.tidymodels.org/
  repository: https://CRAN.R-project.org/package=parsnip
  authors:
  - family-names: Kuhn
    given-names: Max
    email: max@posit.co
  - family-names: Vaughan
    given-names: Davis
    email: davis@posit.co
  year: '2025'
  doi: 10.32614/CRAN.package.parsnip
  version: '>= 1.2.1'
- type: software
  title: 'R: A Language and Environment for Statistical Computing'
  notes: Depends
  url: https://www.R-project.org/
  authors:
  - name: R Core Team
  institution:
    name: 'R Foundation for Statistical Computing (ROR: <https://ror.org/05qewa988>)'
    address: Vienna, Austria
  year: '2025'
  doi: 10.32614/R.manuals
  version: '>= 4.1.0'
- type: software
  title: dplyr
  abstract: 'dplyr: A Grammar of Data Manipulation'
  notes: Imports
  url: https://dplyr.tidyverse.org
  repository: https://CRAN.R-project.org/package=dplyr
  authors:
  - family-names: Wickham
    given-names: Hadley
    email: hadley@posit.co
    orcid: https://orcid.org/0000-0003-4757-117X
  - family-names: François
    given-names: Romain
    orcid: https://orcid.org/0000-0002-2444-4226
  - family-names: Henry
    given-names: Lionel
  - family-names: Müller
    given-names: Kirill
    orcid: https://orcid.org/0000-0002-1416-3412
  - family-names: Vaughan
    given-names: Davis
    email: davis@posit.co
    orcid: https://orcid.org/0000-0003-4777-038X
  year: '2025'
  doi: 10.32614/CRAN.package.dplyr
- type: software
  title: purrr
  abstract: 'purrr: Functional Programming Tools'
  notes: Imports
  url: https://purrr.tidyverse.org/
  repository: https://CRAN.R-project.org/package=purrr
  authors:
  - family-names: Wickham
    given-names: Hadley
    email: hadley@posit.co
    orcid: https://orcid.org/0000-0003-4757-117X
  - family-names: Henry
    given-names: Lionel
    email: lionel@posit.co
  year: '2025'
  doi: 10.32614/CRAN.package.purrr
- type: software
  title: rlang
  abstract: 'rlang: Functions for Base Types and Core R and ''Tidyverse'' Features'
  notes: Imports
  url: https://rlang.r-lib.org
  repository: https://CRAN.R-project.org/package=rlang
  authors:
  - family-names: Henry
    given-names: Lionel
    email: lionel@posit.co
  - family-names: Wickham
    given-names: Hadley
    email: hadley@posit.co
  year: '2025'
  doi: 10.32614/CRAN.package.rlang
- type: software
  title: stats
  abstract: 'R: A Language and Environment for Statistical Computing'
  notes: Imports
  authors:
  - name: R Core Team
  institution:
    name: 'R Foundation for Statistical Computing (ROR: <https://ror.org/05qewa988>)'
    address: Vienna, Austria
  year: '2025'
  doi: 10.32614/R.manuals
- type: software
  title: tibble
  abstract: 'tibble: Simple Data Frames'
  notes: Imports
  url: https://tibble.tidyverse.org/
  repository: https://CRAN.R-project.org/package=tibble
  authors:
  - family-names: Müller
    given-names: Kirill
    email: kirill@cynkra.com
    orcid: https://orcid.org/0000-0002-1416-3412
  - family-names: Wickham
    given-names: Hadley
    email: hadley@rstudio.com
  year: '2025'
  doi: 10.32614/CRAN.package.tibble
- type: software
  title: utils
  abstract: 'R: A Language and Environment for Statistical Computing'
  notes: Imports
  authors:
  - name: R Core Team
  institution:
    name: 'R Foundation for Statistical Computing (ROR: <https://ror.org/05qewa988>)'
    address: Vienna, Austria
  year: '2025'
  doi: 10.32614/R.manuals
- type: software
  title: covr
  abstract: 'covr: Test Coverage for Packages'
  notes: Suggests
  url: https://covr.r-lib.org
  repository: https://CRAN.R-project.org/package=covr
  authors:
  - family-names: Hester
    given-names: Jim
    email: james.f.hester@gmail.com
  year: '2025'
  doi: 10.32614/CRAN.package.covr
- type: software
  title: devtools
  abstract: 'devtools: Tools to Make Developing R Packages Easier'
  notes: Suggests
  url: https://devtools.r-lib.org/
  repository: https://CRAN.R-project.org/package=devtools
  authors:
  - family-names: Wickham
    given-names: Hadley
  - family-names: Hester
    given-names: Jim
  - family-names: Chang
    given-names: Winston
  - family-names: Bryan
    given-names: Jennifer
    email: jenny@rstudio.com
    orcid: https://orcid.org/0000-0002-6983-2759
  year: '2025'
  doi: 10.32614/CRAN.package.devtools
- type: software
  title: knitr
  abstract: 'knitr: A General-Purpose Package for Dynamic Report Generation in R'
  notes: Suggests
  url: https://yihui.org/knitr/
  repository: https://CRAN.R-project.org/package=knitr
  authors:
  - family-names: Xie
    given-names: Yihui
    email: xie@yihui.name
    orcid: https://orcid.org/0000-0003-0645-5666
  year: '2025'
  doi: 10.32614/CRAN.package.knitr
- type: software
  title: recipes
  abstract: 'recipes: Preprocessing and Feature Engineering Steps for Modeling'
  notes: Suggests
  url: https://recipes.tidymodels.org/
  repository: https://CRAN.R-project.org/package=recipes
  authors:
  - family-names: Kuhn
    given-names: Max
    email: max@posit.co
  - family-names: Wickham
    given-names: Hadley
    email: hadley@posit.co
  - family-names: Hvitfeldt
    given-names: Emil
    email: emil.hvitfeldt@posit.co
  year: '2025'
  doi: 10.32614/CRAN.package.recipes
- type: software
  title: rmarkdown
  abstract: 'rmarkdown: Dynamic Documents for R'
  notes: Suggests
  url: https://pkgs.rstudio.com/rmarkdown/
  repository: https://CRAN.R-project.org/package=rmarkdown
  authors:
  - family-names: Allaire
    given-names: JJ
    email: jj@posit.co
  - family-names: Xie
    given-names: Yihui
    email: xie@yihui.name
    orcid: https://orcid.org/0000-0003-0645-5666
  - family-names: Dervieux
    given-names: Christophe
    email: cderv@posit.co
    orcid: https://orcid.org/0000-0003-4474-2498
  - family-names: McPherson
    given-names: Jonathan
    email: jonathan@posit.co
  - family-names: Luraschi
    given-names: Javier
  - family-names: Ushey
    given-names: Kevin
    email: kevin@posit.co
  - family-names: Atkins
    given-names: Aron
    email: aron@posit.co
  - family-names: Wickham
    given-names: Hadley
    email: hadley@posit.co
  - family-names: Cheng
    given-names: Joe
    email: joe@posit.co
  - family-names: Chang
    given-names: Winston
    email: winston@posit.co
  - family-names: Iannone
    given-names: Richard
    email: rich@posit.co
    orcid: https://orcid.org/0000-0003-3925-190X
  year: '2025'
  doi: 10.32614/CRAN.package.rmarkdown
- type: software
  title: roxygen2
  abstract: 'roxygen2: In-Line Documentation for R'
  notes: Suggests
  url: https://roxygen2.r-lib.org/
  repository: https://CRAN.R-project.org/package=roxygen2
  authors:
  - family-names: Wickham
    given-names: Hadley
    email: hadley@posit.co
    orcid: https://orcid.org/0000-0003-4757-117X
  - family-names: Danenberg
    given-names: Peter
    email: pcd@roxygen.org
  - family-names: Csárdi
    given-names: Gábor
    email: csardi.gabor@gmail.com
  - family-names: Eugster
    given-names: Manuel
  year: '2025'
  doi: 10.32614/CRAN.package.roxygen2
- type: software
  title: spelling
  abstract: 'spelling: Tools for Spell Checking in R'
  notes: Suggests
  url: https://ropensci.r-universe.dev/spelling
  repository: https://CRAN.R-project.org/package=spelling
  authors:
  - family-names: Ooms
    given-names: Jeroen
    email: jeroenooms@gmail.com
    orcid: https://orcid.org/0000-0002-4035-0289
  - family-names: Hester
    given-names: Jim
    email: james.hester@rstudio.com
  year: '2025'
  doi: 10.32614/CRAN.package.spelling
- type: software
  title: testthat
  abstract: 'testthat: Unit Testing for R'
  notes: Suggests
  url: https://testthat.r-lib.org
  repository: https://CRAN.R-project.org/package=testthat
  authors:
  - family-names: Wickham
    given-names: Hadley
    email: hadley@posit.co
  year: '2025'
  doi: 10.32614/CRAN.package.testthat
- type: software
  title: workflows
  abstract: 'workflows: Modeling Workflows'
  notes: Suggests
  url: https://workflows.tidymodels.org
  repository: https://CRAN.R-project.org/package=workflows
  authors:
  - family-names: Vaughan
    given-names: Davis
    email: davis@posit.co
  - family-names: Couch
    given-names: Simon
    email: simon.couch@posit.co
    orcid: https://orcid.org/0000-0001-5676-5107
  - family-names: Frick
    given-names: Hannah
    email: hannah@posit.co
    orcid: https://orcid.org/0000-0002-6049-5258
  year: '2025'
  doi: 10.32614/CRAN.package.workflows

GitHub Events

Total

Issues event: 2
Issue comment event: 2
Push event: 40
Fork event: 1

Last Year

Issues event: 2
Issue comment event: 2
Push event: 40
Fork event: 1

Committers

Last synced: 8 months ago

All Time

Total Commits: 266
Total Committers: 2
Avg Commits per committer: 133.0
Development Distribution Score (DDS): 0.004

Past Year

Commits: 6
Committers: 1
Avg Commits per committer: 6.0
Development Distribution Score (DDS): 0.0

Top Committers

Name	Email	Commits
Hamada S. Badr	h**r@g**m	265
topepo	m**n@g**m	1

Issues and Pull Requests

Last synced: 6 months ago

All Time

Total issues: 1
Total pull requests: 1
Average time to close issues: 3 days
Average time to close pull requests: about 17 hours
Total issue authors: 1
Total pull request authors: 1
Average comments per issue: 2.0
Average comments per pull request: 1.0
Merged pull requests: 1
Bot issues: 0
Bot pull requests: 0

Past Year

Issues: 1
Pull requests: 0
Average time to close issues: 3 days
Average time to close pull requests: N/A
Issue authors: 1
Pull request authors: 0
Average comments per issue: 2.0
Average comments per pull request: 0
Merged pull requests: 0
Bot issues: 0
Bot pull requests: 0

View more stats

Top Authors

Issue Authors

chadapol (1)

Pull Request Authors

topepo (1)

Top Labels

Issue Labels

Pull Request Labels

Packages

Total packages: 1
Total downloads:
- cran 599 last-month

Total dependent packages: 0
Total dependent repositories: 0
Total versions: 6
Total maintainers: 1

cran.r-project.org: additive

Bindings for Additive TidyModels

Homepage: https://hsbadr.github.io/additive/
Documentation: http://cran.r-project.org/web/packages/additive/additive.pdf
License: MIT + file LICENSE
Latest release: 1.0.1
published almost 2 years ago

Versions: 6
Dependent Packages: 0
Dependent Repositories: 0
Downloads: 599 Last month

Rankings

Stargazers count: 21.1%

Forks count: 21.9%

Average: 28.5%

Dependent packages count: 29.8%

Downloads: 34.2%

Dependent repos count: 35.5%

Maintainers (1)

badr@jhu.edu

Last synced: 6 months ago

ecosyste.ms

Data

Tools

Indexes

Applications

Experiments

Open Source Science

additive

Science Score: 67.0%

Keywords

Repository

Basic Info

Statistics

Topics

Metadata Files

README.Rmd

Owner

Citation (CITATION.cff)

GitHub Events

Total

Last Year

Committers

All Time

Past Year

Top Committers

Issues and Pull Requests

All Time

Past Year

Top Authors

Issue Authors

Pull Request Authors

Top Labels

Issue Labels

Pull Request Labels

Packages

cran.r-project.org: additive

Rankings

Maintainers (1)