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

# rwasm <a href="https://r-wasm.github.io/rwasm/"><img src="man/figures/logo.png" align="right" height="138" alt="rwasm website" /></a>

<!-- badges: start -->
[![Lifecycle: experimental](https://img.shields.io/badge/lifecycle-experimental-orange.svg)](https://lifecycle.r-lib.org/articles/stages.html)
[![R-CMD-check](https://github.com/r-wasm/rwasm/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/r-wasm/rwasm/actions/workflows/R-CMD-check.yaml)
[![Codecov test coverage](https://codecov.io/gh/r-wasm/rwasm/graph/badge.svg)](https://app.codecov.io/gh/r-wasm/rwasm)
<!-- badges: end -->

## Build R Packages for WebAssembly

This package provides functions to help build R packages compiled for WebAssembly (Wasm), manage Wasm binary R package libraries and repositories, and prepare webR compatible filesystem images for static web hosting of data files and R packages.

## Requirements

Building binary R packages for Wasm requires cross-compiling packages containing C/C++/Fortran source code using a Wasm development toolchain. As such, the [Emscripten](https://emscripten.org) C/C++ toolchain and a [version of LLVM `flang` configured to output Wasm](https://github.com/lionel-/f18-llvm-project/tree/fix-webr) must be available in the environment for the `rwasm` package to function.

For convenience, webR GitHub repository provides a [Docker container](https://github.com/r-wasm/webr/pkgs/container/webr) containing the full Wasm development environment required for building Wasm R packages.

## Installation
The `rwasm` package is not yet on CRAN. You can install the development version from GitHub via:

```r
# install.packages("pak")
pak::pak("r-wasm/rwasm")
```

Further information explaining how to set up the Wasm development environment and build R packages can be found in `vignette("rwasm")`.