https://github.com/tidymodels/modelenv

Provide Tools to Register Models for use in Tidymodels
https://github.com/tidymodels/modelenv

Last synced: 3 days ago
JSON representation

Provide Tools to Register Models for use in Tidymodels

• Host: GitHub
• URL: https://github.com/tidymodels/modelenv
• Owner: tidymodels
• License: other
• Created: 2022-10-12T22:05:43.000Z (about 2 years ago)
• Default Branch: main
• Last Pushed: 2024-10-14T16:32:40.000Z (30 days ago)
• Last Synced: 2024-10-31T22:03:17.363Z (12 days ago)
• Language: R
• Homepage: http://modelenv.tidymodels.org/
• Size: 5.25 MB
• Stars: 4
• Watchers: 4
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.Rmd
  • License: LICENSE
  • Code of conduct: .github/CODE_OF_CONDUCT.md

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%"

)

```

# modelenv

[![Codecov test coverage](https://codecov.io/gh/tidymodels/modelenv/branch/main/graph/badge.svg)](https://app.codecov.io/gh/tidymodels/modelenv?branch=main)

[![R-CMD-check](https://github.com/tidymodels/modelenv/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/tidymodels/modelenv/actions/workflows/R-CMD-check.yaml)

modelenv is a *developer focused* package designed to provide tools to register models much in the same as is [done in parsnip](https://parsnip.tidymodels.org/reference/set_new_model.html). This package **does not** replace parsnip's registration functions, but will be used in tidyclust and future non-parsnip modeling packages to avoid complex dependencies.

## Installation

You can install the released version of modelenv from [CRAN](https://CRAN.R-project.org) with:

``` r

install.packages("modelenv")

```

And the development version from [GitHub](https://github.com/) with:

``` r

# install.packages("pak")

pak::pak("tidymodels/modelenv")

```

## Learn more

These functions have near identical interfaces to their parsnip equivalent, see [tidymodels.org - How to build a parsnip model](https://www.tidymodels.org/learn/develop/models/) for instructions of how to use these functions.