README.Rmd

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

# qlm

<!-- badges: start -->
[![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/qlm)](https://CRAN.R-project.org/package=qlm)
<!-- badges: end -->

qlm is a package to create SQL queries to compute predictions from linear
models.

## Installation

Install the development version of qlm:

``` r
devtools::install_github("assuncaolfi/qlm")
```

## Example

Fit a model:

```{r model}
library(qlm)

data(iris)
iris <- janitor::clean_names(iris)
iris$large_sepal <- iris$sepal_length > median(iris$sepal_length)

model <- glm(
  large_sepal ~ sepal_width + petal_length + species, 
  data = iris, 
  family = binomial("logit")
)
```

Make a predictive query:

```{r query}
query <- qlm(model, inverse_link = "1 / (1 + EXP(-{x}))")
cat(query)
```

Formula interactions and transformations are not supported and should be
precomputed in the data query.