prqlr

R bindings for the prql-compiler Rust library, powered by the extendr framework.

This version supports PRQL 0.8.1.

Installation

Requires R 4.2.0 or later.

This package can be installed from CRAN or R-universe. If available, a binary package will be installed.

# Install from CRAN
install.packages("prqlr")

# Install from R-universe
install.packages("prqlr", repos = "https://eitsupi.r-universe.dev")

For source installation, the Rust toolchain (Rust 1.61 or later) must be configured. Please check the https://github.com/r-rust/hellorust repository for about Rust code in R packages.

Examples

library(prqlr)
"from mtcars | filter cyl > 6 | select [cyl, mpg]" |>
  prql_compile() |>
  cat()
#> SELECT
#>   cyl,
#>   mpg
#> FROM
#>   mtcars
#> WHERE
#>   cyl > 6
#> 
#> -- Generated by PRQL compiler version:0.8.1 (https://prql-lang.org)

PRQL’s pipelines can be joined by the newline character (\n), or actual newlines in addition to |.

"from mtcars \n filter cyl > 6 \n select [cyl, mpg]" |>
  prql_compile() |>
  cat()
#> SELECT
#>   cyl,
#>   mpg
#> FROM
#>   mtcars
#> WHERE
#>   cyl > 6
#> 
#> -- Generated by PRQL compiler version:0.8.1 (https://prql-lang.org)

"from mtcars
filter cyl > 6
select [cyl, mpg]" |>
  prql_compile() |>
  cat()
#> SELECT
#>   cyl,
#>   mpg
#> FROM
#>   mtcars
#> WHERE
#>   cyl > 6
#> 
#> -- Generated by PRQL compiler version:0.8.1 (https://prql-lang.org)

Thanks to the tidyquery package, we can even convert a PRQL query to a SQL query and then to a dplyr query!

"from mtcars
filter cyl > 6
select [cyl, mpg]" |>
  prql_compile() |>
  tidyquery::show_dplyr()
#> mtcars %>%
#>   filter(cyl > 6) %>%
#>   select(cyl, mpg)

{knitr} integration

Using prqlr with knitr makes it easy to create documents that lists PRQL queries and a translated SQL queries, or documents that lists PRQL queries and tables of data retrieved by PRQL queries.

Please check the vignette vignette("knitr", "prqlr") for details.

Development

Use the rextendr::document() function to generate R source code from Rust source code in the src directory.