Merge pull request #9 from tidymodels/RC-0.1.0

Rc 0.1.0

.Rbuildignore

@@ -2,3 +2,6 @@
 ^\.Rproj\.user$
 ^LICENSE\.md$
 ^\.github$
+^README\.Rmd$
+^cran-comments\.md$
+^CRAN-SUBMISSION$

DESCRIPTION

@@ -1,14 +1,16 @@
 Package: orbital
-Title: Turn Tidymodels Workflows Into Series of Equations
-Version: 0.0.0.9000
-Authors@R: 
-    person("Emil", "Hvitfeldt", , "[email protected]", role = c("aut", "cre"),
-           comment = c(ORCID = "0000-0002-0679-1945"))
-Description: Turning tidymodels workflows into series of equations, to
-    allow for low dependency prediction locally or in databases.
+Title: Predict with 'tidymodels' Workflows in Databases
+Version: 0.1.0.9000
+Authors@R: c(
+    person("Emil", "Hvitfeldt", , "[email protected]", role = c("aut", "cre")),
+    person(given = "Posit Software, PBC", role = c("cph", "fnd"))
+  )
+Description: Turn 'tidymodels' workflows into objects containing the sufficient
+    sequential equations to perform predictions. These smaller objects allow 
+    for low dependency prediction locally or directly in databases.
 License: MIT + file LICENSE
-URL: https://github.com/EmilHvitfeldt/orbital
-BugReports: https://github.com/EmilHvitfeldt/orbital/issues
+URL: https://github.com/tidymodels/orbital
+BugReports: https://github.com/tidymodels/orbital/issues
 Imports: 
     cli,
     rlang

NEWS.md

@@ -0,0 +1,5 @@
+# orbital (development version)
+
+# orbital 0.1.0
+
+* Initial CRAN submission.

README.Rmd

@@ -0,0 +1,75 @@
+---
+output: github_document
+---
+
+<!-- README.md is generated from README.Rmd. Please edit that file -->
+
+```{r, include = FALSE}
+knitr::opts_chunk$set(
+  collapse = TRUE,
+  comment = "#>",
+  fig.path = "man/figures/README-",
+  out.width = "100%"
+)
+```
+
+# orbital
+
+<!-- badges: start -->
+<!-- badges: end -->
+
+The goal of orbital is to enable running predictions of tidymodels [workflows](https://workflows.tidymodels.org/) inside databases.
+
+## Installation
+
+To install it, use:
+
+``` r
+install.packages("orbital")
+```
+
+You can install the development version of orbital from [GitHub](https://github.com/) with:
+
+``` r
+# install.packages("devtools")
+devtools::install_github("tidymodels/orbital")
+```
+
+## Example
+
+Given a fitted workflow
+
+```{r}
+library(tidymodels)
+
+rec_spec <- recipe(mpg ~ ., data = mtcars) %>%
+  step_normalize(all_numeric_predictors())
+
+lm_spec <- linear_reg()
+
+wf_spec <- workflow(rec_spec, lm_spec)
+
+wf_fit <- fit(wf_spec, mtcars)
+```
+
+You can predict with it like normal.
+
+```{r}
+predict(wf_fit, mtcars)
+```
+
+We can get the same results by first creating an orbital object
+
+```{r}
+library(orbital)
+orbital_obj <- orbital(wf_fit)
+orbital_obj
+```
+
+and then "predicting" with it using `orbital_predict()` to get the same results
+
+```{r}
+mtcars %>%
+  as_tibble() %>%
+  orbital_predict(orbital_obj)
+```

README.md

@@ -0,0 +1,127 @@
+
+<!-- README.md is generated from README.Rmd. Please edit that file -->
+
+# orbital
+
+<!-- badges: start -->
+<!-- badges: end -->
+
+The goal of orbital is to enable running predictions of tidymodels
+[workflows](https://workflows.tidymodels.org/) inside databases.
+
+## Installation
+
+To install it, use:
+
+``` r
+install.packages("orbital")
+```
+
+You can install the development version of orbital from
+[GitHub](https://github.com/) with:
+
+``` r
+# install.packages("devtools")
+devtools::install_github("tidymodels/orbital")
+```
+
+## Example
+
+Given a fitted workflow
+
+``` r
+library(tidymodels)
+#> ── Attaching packages ────────────────────────────────────── tidymodels 1.2.0 ──
+#> ✔ broom        1.0.6      ✔ recipes      1.0.10
+#> ✔ dials        1.2.1      ✔ rsample      1.2.1 
+#> ✔ dplyr        1.1.4      ✔ tibble       3.2.1 
+#> ✔ ggplot2      3.5.1      ✔ tidyr        1.3.1 
+#> ✔ infer        1.0.7      ✔ tune         1.2.1 
+#> ✔ modeldata    1.4.0      ✔ workflows    1.1.4 
+#> ✔ parsnip      1.2.1      ✔ workflowsets 1.1.0 
+#> ✔ purrr        1.0.2      ✔ yardstick    1.3.1
+#> ── Conflicts ───────────────────────────────────────── tidymodels_conflicts() ──
+#> ✖ purrr::discard() masks scales::discard()
+#> ✖ dplyr::filter()  masks stats::filter()
+#> ✖ dplyr::lag()     masks stats::lag()
+#> ✖ recipes::step()  masks stats::step()
+#> • Dig deeper into tidy modeling with R at https://www.tmwr.org
+```
+
+``` r
+
+rec_spec <- recipe(mpg ~ ., data = mtcars) %>%
+  step_normalize(all_numeric_predictors())
+
+lm_spec <- linear_reg()
+
+wf_spec <- workflow(rec_spec, lm_spec)
+
+wf_fit <- fit(wf_spec, mtcars)
+```
+
+You can predict with it like normal.
+
+``` r
+predict(wf_fit, mtcars)
+#> # A tibble: 32 × 1
+#>    .pred
+#>    <dbl>
+#>  1  22.6
+#>  2  22.1
+#>  3  26.3
+#>  4  21.2
+#>  5  17.7
+#>  6  20.4
+#>  7  14.4
+#>  8  22.5
+#>  9  24.4
+#> 10  18.7
+#> # ℹ 22 more rows
+```
+
+We can get the same results by first creating an orbital object
+
+``` r
+library(orbital)
+orbital_obj <- orbital(wf_fit)
+orbital_obj
+#> 
+#> ── orbital Object ──────────────────────────────────────────────────────────────
+#> • cyl = (cyl - 6.1875) / 1.78592164694654
+#> • disp = (disp - 230.721875) / 123.938693831382
+#> • hp = (hp - 146.6875) / 68.5628684893206
+#> • drat = (drat - 3.5965625) / 0.534678736070971
+#> • wt = (wt - 3.21725) / 0.978457442989697
+#> • qsec = (qsec - 17.84875) / 1.78694323609684
+#> • vs = (vs - 0.4375) / 0.504016128774185
+#> • am = (am - 0.40625) / 0.498990917235846
+#> • gear = (gear - 3.6875) / 0.737804065256947
+#> • carb = (carb - 2.8125) / 1.61519997763185
+#> • .pred = 20.090625 + (cyl * -0.199023961804222) + (disp * 1.652752216787 ...
+#> ────────────────────────────────────────────────────────────────────────────────
+#> 11 equations in total.
+```
+
+and then “predicting” with it using `orbital_predict()` to get the same
+results
+
+``` r
+mtcars %>%
+  as_tibble() %>%
+  orbital_predict(orbital_obj)
+#> # A tibble: 32 × 1
+#>    .pred
+#>    <dbl>
+#>  1  22.6
+#>  2  22.1
+#>  3  26.3
+#>  4  21.2
+#>  5  17.7
+#>  6  20.4
+#>  7  14.4
+#>  8  22.5
+#>  9  24.4
+#> 10  18.7
+#> # ℹ 22 more rows
+```

cran-comments.md

@@ -0,0 +1,9 @@
+* used single quotes around tidymodels in title and description
+* Expanded description
+* methods described in this package are original (afaik) and doesn't have doi/isbn references
+
+## R CMD check results
+
+0 errors | 0 warnings | 1 note
+
+* This is a new release.