Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/extendr/rextendr
An R package that helps scaffolding extendr-enabled packages or compiling Rust code dynamically
https://github.com/extendr/rextendr
Last synced: 4 days ago
JSON representation
An R package that helps scaffolding extendr-enabled packages or compiling Rust code dynamically
- Host: GitHub
- URL: https://github.com/extendr/rextendr
- Owner: extendr
- License: other
- Created: 2020-11-20T23:09:23.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2024-11-29T08:05:21.000Z (13 days ago)
- Last Synced: 2024-11-30T22:04:25.062Z (11 days ago)
- Language: R
- Homepage: https://extendr.github.io/rextendr/
- Size: 9.28 MB
- Stars: 197
- Watchers: 8
- Forks: 27
- Open Issues: 44
-
Metadata Files:
- Readme: README.Rmd
- Changelog: NEWS.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE-OF-CONDUCT.md
Awesome Lists containing this project
- jimsghstars - extendr/rextendr - An R package that helps scaffolding extendr-enabled packages or compiling Rust code dynamically (R)
README
---
output: github_document
---
```{r, include = FALSE}
knitr::opts_chunk$set(
message = FALSE,
collapse = TRUE,
comment = "#>",
fig.path = "man/figures/README-",
out.width = "100%"
)
```
# Call Rust code from R 
[](https://CRAN.R-project.org/package=rextendr)
[](https://extendr.r-universe.dev/rextendr)
[](https://lifecycle.r-lib.org/articles/stages.html#stable)
[](https://github.com/extendr/rextendr/actions)
[](https://app.codecov.io/gh/extendr/rextendr)
## Installation
To install release version from CRAN, run:
```{r, eval = FALSE}
install.packages("rextendr")
```
or use `{remotes}`
```{r, eval = FALSE}
remotes::install_cran("rextendr")
```
You can also install `{rextendr}` from [r-universe](https://extendr.r-universe.dev/rextendr):
```{r, results = "hide"}
install.packages("rextendr", repos = c("https://extendr.r-universe.dev", "https://cloud.r-project.org"))
```
Latest development version can be installed from GitHub:
```{r, eval = FALSE}
remotes::install_github("extendr/rextendr")
```
To execute Rust code, you will also need to set up a working Rust toolchain. See the [installation instructions for libR-sys](https://github.com/extendr/libR-sys) for help. If you can successfully build libR-sys you're good.
## Usage
### Sitrep
A good first step is to check the status of Rust toolchain and available targets using `rust_sitrep()`. If everything is OK, you should see something like this:
```{r eval=FALSE, echo=TRUE}
rust_sitrep()
# Rust infrastructure sitrep:
# ✔ "rustup": 1.26.0 (5af9b9484 2023-04-05)
# ✔ "cargo": 1.72.0 (103a7ff2e 2023-08-15)
# ℹ host: x86_64-pc-windows-msvc
# ℹ toolchain: stable-x86_64-pc-windows-msvc (default)
# ℹ target: x86_64-pc-windows-gnu
```
If, for instance, no toolchain is found, you will see something like this:
```{r eval=FALSE, echo=TRUE}
rust_sitrep()
# Rust infrastructure sitrep:
# ✔ "rustup": 1.26.0 (5af9b9484 2023-04-05)
# ✔ "cargo": 1.72.0 (103a7ff2e 2023-08-15)
# ℹ host: x86_64-pc-windows-msvc
# ! Toolchain stable-x86_64-pc-windows-msvc is required to be installed and set as default
# ℹ Run `rustup toolchain install stable-x86_64-pc-windows-msvc` to install it
# ℹ Run `rustup default stable-x86_64-pc-windows-msvc` to make it default
```
Finally, if you are missing the required target (on all platforms but Windows `{rextendr}` uses default target), the report will resemble the following:
```{r eval=FALSE, echo=TRUE}
rust_sitrep()
# Rust infrastructure sitrep:
# ✔ "rustup": 1.26.0 (5af9b9484 2023-04-05)
# ✔ "cargo": 1.72.0 (103a7ff2e 2023-08-15)
# ℹ host: x86_64-pc-windows-msvc
# i toolchains: nightly-x86_64-pc-windows-msvc and stable-x86_64-pc-windows-msvc (default)
# i targets: x86_64-pc-windows-msvc and i686-pc-windows-msvc
# ! Target x86_64-pc-windows-gnu is required on this host machine
# i Run `rustup target add x86_64-pc-windows-gnu` to install it
```
### Code examples
Basic use example:
```{r}
library(rextendr)
# create a Rust function
rust_function("fn add(a:f64, b:f64) -> f64 { a + b }")
# call it from R
add(2.5, 4.7)
```
Something more sophisticated:
```{r}
library(rextendr)
# Rust function that computes a sum of integer or double vectors, preserving the type
rust_function(
"fn get_sum(x : Either) -> Either {
match x {
Either::Left(x) => Either::Left(x.iter().sum()),
Either::Right(x) => Either::Right(x.iter().sum()),
}
}",
use_dev_extendr = TRUE, # Use development version of extendr from GitHub
features = "either", # Enable support for Either crate
)
x <- 1:5
y <- c(1, 2, 3, 4, 5)
tibble::tibble(
Name = c("x", "y"),
Data = list(x, y),
Types = purrr::map_chr(Data, typeof),
Sum = purrr::map(Data, get_sum),
SumRaw = purrr::flatten_dbl(Sum),
ResultType = purrr::map_chr(Sum, typeof)
)
```
The package also enables a new chunk type for knitr, `extendr`, which compiles and evaluates Rust code. For example, a code chunk such as this one:
````markdown
`r ''````{extendr}
rprintln!("Hello from Rust!");
let x = 5;
let y = 7;
let z = x*y;
z
```
````
would create the following output in the knitted document:
```{extendr}
rprintln!("Hello from Rust!");
let x = 5;
let y = 7;
let z = x*y;
z
```
## See also
- The [cargo-framework](https://github.com/dbdahl/cargo-framework) and associated R package [cargo](https://cran.r-project.org/package=cargo)
- The [r-rust](https://github.com/r-rust) organization
-----
Please note that this project is released with a [Contributor Code of Conduct](https://github.com/extendr/rextendr/blob/main/CODE-OF-CONDUCT.md). By participating in this project you agree to abide by its terms.