https://github.com/tidymodels/plsmod

Model Wrappers for Projection Methods
https://github.com/tidymodels/plsmod

Last synced: 3 days ago
JSON representation

Model Wrappers for Projection Methods

• Host: GitHub
• URL: https://github.com/tidymodels/plsmod
• Owner: tidymodels
• License: other
• Created: 2020-04-07T02:47:29.000Z (over 4 years ago)
• Default Branch: main
• Last Pushed: 2024-10-16T12:57:57.000Z (28 days ago)
• Last Synced: 2024-10-31T22:03:17.282Z (12 days ago)
• Language: R
• Homepage: https://plsmod.tidymodels.org
• Size: 4.75 MB
• Stars: 14
• Watchers: 5
• Forks: 2
• Open Issues: 3
• Metadata Files:
  • Readme: README.Rmd
  • Changelog: NEWS.md
  • 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%"

)

```

# plsmod

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

[![Lifecycle: experimental](https://img.shields.io/badge/lifecycle-experimental-orange.svg)](https://lifecycle.r-lib.org/articles/stages.html)

[![CRAN status](https://www.r-pkg.org/badges/version/plsmod)](https://CRAN.R-project.org/package=plsmod)

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

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

This package is a helper package for [parsnip](https://parsnip.tidymodels.org) that enables linear projection models (such as partial least squares, PLS) in the tidymodels infrastructure. 

## Installation

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

``` r

install.packages("plsmod")

```

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

``` r

# install.packages("pak")

pak::pak("tidymodels/plsmod")

```

## Available Engines

The plsmod package provides engines for the models in the following table.

```{r, echo=FALSE, message=FALSE}

library(parsnip)

parsnip_models <- get_from_env("models") %>%

  setNames(., .) %>%

  purrr::map_dfr(get_from_env, .id = "model")

library(plsmod)

plsmod_models <- get_from_env("models") %>%

  setNames(., .) %>%

  purrr::map_dfr(get_from_env, .id = "model")

dplyr::anti_join(

  plsmod_models, parsnip_models, 

  by = c("model", "engine", "mode")

) %>%

  knitr::kable()

```

## Contributing

This project is released with a [Contributor Code of Conduct](https://www.contributor-covenant.org/version/2/1/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://community.rstudio.com/new-topic?category_id=15&tags=tidymodels,question).

- If you think you have encountered a bug, please [submit an issue](https://github.com/tidymodels/plsmod/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/).