Data

Tools

Indexes

Applications

Experiments

Open Source Science

shinymodels

https://github.com/tidymodels/shinymodels

Science Score: 13.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • ○
    CITATION.cff file
  • ✓
    codemeta.json file
    Found codemeta.json file
  • ○
    .zenodo.json file
  • ○
    DOI references
  • ○
    Academic publication links
  • ○
    Committers with academic emails
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (14.4%) to scientific vocabulary

Keywords

r r-package rstats shiny

Keywords from Contributors

tidyverse tidy-data setup data-manipulation visualisation
Last synced: 9 months ago · JSON representation

Repository

Basic Info
Statistics
  • Stars: 48
  • Watchers: 6
  • Forks: 5
  • Open Issues: 3
  • Releases: 2
Topics
r r-package rstats shiny
Created almost 5 years ago · Last pushed over 1 year ago
Metadata Files
Readme Changelog Contributing License Code of conduct

README.Rmd 

---
output: github_document
---

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

# shinymodels


[![Lifecycle: experimental](https://img.shields.io/badge/lifecycle-experimental-orange.svg)](https://lifecycle.r-lib.org/articles/stages.html#experimental)
[![CRAN status](https://www.r-pkg.org/badges/version/shinymodels)](https://CRAN.R-project.org/package=shinymodels)
[![Codecov test coverage](https://codecov.io/gh/tidymodels/shinymodels/branch/main/graph/badge.svg)](https://app.codecov.io/gh/tidymodels/shinymodels?branch=main)
[![R-CMD-check](https://github.com/tidymodels/shinymodels/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/tidymodels/shinymodels/actions/workflows/R-CMD-check.yaml)
[![R-CMD-check-no-suggests](https://github.com/tidymodels/shinymodels/actions/workflows/R-CMD-check-no-suggests.yaml/badge.svg)](https://github.com/tidymodels/shinymodels/actions/workflows/R-CMD-check-no-suggests.yaml)


The goal of shinymodels is to launch a Shiny app given tidymodels' tuning or resampling results, to make it easier to explore the modeling results.

## Installation

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

``` r
install.packages("shinymodels") 
```

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

``` r
# install.packages("pak")
pak::pak("tidymodels/shinymodels")
```

## Example

Start by tuning or fitting to resampling folds, using tune functions like `fit_resamples()` or `tune_bayes()`.

As an example, we will simulate a simple relationship:

```{r load, include = FALSE}
library(shinymodels)
library(tidymodels)
tidymodels_prefer()
```

```{r}
library(shinymodels)
library(tidymodels)
tidymodels_prefer()

set.seed(1)
n <- 100
simulated <-
  data.frame(x1 = runif(n, min = -1), x2 = runif(n)) %>% 
  mutate(y = 3 - 5 * x1 + 15 * x1^2 +  + 10 * x2 + rnorm(n, sd = 5))
```

Let's resample a linear regression model that is missing an important nonlinear term (i.e., `poly(x1, 2)`):

```{r}
set.seed(2)
folds <- vfold_cv(simulated)

reg_res <-
  linear_reg() %>%
  fit_resamples(y ~ .,
                resamples = folds,
                control = control_resamples(save_pred = TRUE))
```

To interactively assess the model fit, we can use the  `explore()` function: 

```r
explore(reg_res)
```

Use the Shiny app to explore the model results and detect any outliers or problematic observations. In the image below, the observed and predicted values are visualized, with one sample selected and highlighted. The residuals are also plotted against `x1` and the quadratic pattern shows that a nonlinear term should be added.  

![screenshot of shiny app. Options are shown in a column to the left. In the main area 3 tabs are shown; Observed vs. Predicted, Residuals vs. Predicted, and Residals vs. A numeric predictor.](man/figures/example.png)

The `explore()` function can be used with objects produced by `fit_resamples()`, `last_fit()`, or any of the `tune_*()` functions. 


## 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://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/shinymodels/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/).

Owner

  • Name: tidymodels
  • Login: tidymodels
  • Kind: organization

GitHub Events

Total
  • Watch event: 2
  • Delete event: 1
  • Push event: 14
  • Pull request event: 2
  • Create event: 1
Last Year
  • Watch event: 2
  • Delete event: 1
  • Push event: 14
  • Pull request event: 2
  • Create event: 1

Committers

Last synced: about 1 year ago

All Time
  • Total Commits: 129
  • Total Committers: 7
  • Avg Commits per committer: 18.429
  • Development Distribution Score (DDS): 0.651
Past Year
  • Commits: 8
  • Committers: 1
  • Avg Commits per committer: 8.0
  • Development Distribution Score (DDS): 0.0
Top Committers
Name Email Commits
adhikars11 6****1 45
Max Kuhn m****n@g****m 34
simonpcouch s****h@g****m 23
Emil Hvitfeldt e****t@g****m 17
Julia Silge j****e@g****m 5
Carson c****1@g****m 4
Romain Francois r****n@r****m 1
Committer Domains (Top 20 + Academic)
rstudio.com: 1

Issues and Pull Requests

Last synced: 9 months ago

All Time
  • Total issues: 29
  • Total pull requests: 53
  • Average time to close issues: 18 days
  • Average time to close pull requests: 6 days
  • Total issue authors: 6
  • Total pull request authors: 7
  • Average comments per issue: 1.72
  • Average comments per pull request: 1.17
  • Merged pull requests: 43
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 0
  • Pull requests: 1
  • Average time to close issues: N/A
  • Average time to close pull requests: about 1 hour
  • Issue authors: 0
  • Pull request authors: 1
  • Average comments per issue: 0
  • Average comments per pull request: 0.0
  • Merged pull requests: 1
  • Bot issues: 0
  • Bot pull requests: 0
View more stats
Top Authors
Issue Authors
  • topepo (16)
  • adhikars11 (7)
  • simonpcouch (3)
  • tanthiamhuat (1)
  • koenniem (1)
  • EmilHvitfeldt (1)
Pull Request Authors
  • adhikars11 (26)
  • topepo (13)
  • simonpcouch (11)
  • cpsievert (4)
  • romainfrancois (1)
  • EmilHvitfeldt (1)
  • juliasilge (1)
Top Labels
Issue Labels
in progress (5) feature (4) bug (4) help wanted :heart: (2) future (2) done (1) Hold on (1)
Pull Request Labels

Packages

  • Total packages: 1
  • Total downloads:
    • cran 320 last-month
  • Total docker downloads: 76
  • Total dependent packages: 0
  • Total dependent repositories: 0
  • Total versions: 2
  • Total maintainers: 1
cran.r-project.org: shinymodels

Interactive Assessments of Models

  • Versions: 2
  • Dependent Packages: 0
  • Dependent Repositories: 0
  • Downloads: 320 Last month
  • Docker Downloads: 76
Rankings
Stargazers count: 8.0%
Forks count: 17.8%
Dependent packages count: 29.8%
Average: 31.1%
Dependent repos count: 35.5%
Downloads: 64.4%
Maintainers (1)
simon.couch@posit.co
Last synced: 9 months ago

Dependencies

DESCRIPTION cran
  • R >= 2.10 depends
  • ggplot2 * depends
  • DT * imports
  • dplyr * imports
  • generics >= 0.1.0 imports
  • glue * imports
  • htmltools * imports
  • magrittr * imports
  • parsnip * imports
  • plotly * imports
  • purrr * imports
  • rlang * imports
  • scales * imports
  • shiny * imports
  • shinydashboard * imports
  • stats * imports
  • tidyr * imports
  • tidyselect * imports
  • tune * imports
  • yardstick * imports
  • covr * suggests
  • knitr * suggests
  • markdown * suggests
  • modeldata * suggests
  • rmarkdown * suggests
  • shinytest * suggests
  • spelling * suggests
  • testthat >= 3.0.0 suggests
.github/workflows/R-CMD-check.yaml actions
  • actions/checkout v2 composite
  • r-lib/actions/check-r-package v2 composite
  • r-lib/actions/setup-pandoc v2 composite
  • r-lib/actions/setup-r v2 composite
  • r-lib/actions/setup-r-dependencies v2 composite
.github/workflows/lock.yaml actions
  • dessant/lock-threads v2 composite
.github/workflows/pkgdown.yaml actions
  • JamesIves/github-pages-deploy-action 4.1.4 composite
  • actions/checkout v2 composite
  • r-lib/actions/setup-pandoc v2 composite
  • r-lib/actions/setup-r v2 composite
  • r-lib/actions/setup-r-dependencies v2 composite
.github/workflows/pr-commands.yaml actions
  • actions/checkout v2 composite
  • r-lib/actions/pr-fetch v2 composite
  • r-lib/actions/pr-push v2 composite
  • r-lib/actions/setup-r v2 composite
  • r-lib/actions/setup-r-dependencies v2 composite
.github/workflows/test-coverage.yaml actions
  • actions/checkout v2 composite
  • r-lib/actions/setup-r v2 composite
  • r-lib/actions/setup-r-dependencies v2 composite