README.md

webR Extension for Quarto

Important

Looking for the official Quarto WebAssembly backend? Check out quarto-live!

This community developed Quarto extension enables the webR code cell within various Quarto formats, including HTML, RevealJS, Websites, Blogs, and Books.

Take a look at a live example of the extension in action here! To delve deeper into the extension's capabilities, see our comprehensive documentation website.

Looking for a Python version? Check out quarto-pyodide!

Note

Please note that the {quarto-webr} Quarto extension is a community-driven initiative and is not affiliated with Posit, Quarto, or the main webR project. Its evolution and maintenance stem solely from the collective efforts of community members.

Background

If you're new to webR, this cutting-edge technology empowers you to:

"run R code in the browser without the need for an R server to execute the code."

For a deeper understanding of webR, explore the following resources:

• webR Documentation
• webR Source Code

Quick Start Video Guide

For those new to Quarto and Quarto Extensions, we highly recommend checking out this informative YouTube video to get started quickly:

Installation

To use this extension in a Quarto project, install it from within the project's working directory by typing into Terminal:

quarto add coatless/quarto-webr

After the installation process is finished, the extension will be readily available for Quarto documents within the designated working directory. Please note that if you are working on projects located in different directories, you will need to repeat this installation step for each of those directories.

Usage

For each document, place the webr filter in the document's header:

filters:
  - webr

Then, place the R code for webR in a code block marked with {webr-r}

---
title: webR in Quarto HTML Documents
format: html
engine: knitr
filters:
  - webr
---

This is a webR-enabled code cell in a Quarto HTML document.

```{webr-r}
fit = lm(mpg ~ am, data = mtcars)

summary(fit)
```

The rendered document can be viewed online here.

Note: If you don't specify the engine: knitr, the default compute engine used will be jupyter. This could trigger prompts to install Python. However, if you specify engine: knitr, there's no need to install Python.

There are many more customization options that are available. Please see the customization documentation for more examples.

For specific deployment usage cases, please see Templates.

Help

For troubleshooting help, please see our troubleshooting page.

To report a bug, please add an issue to the repository's bug tracker.

Want to contribute a feature? Please open an issue ticket to discuss the feature before sending a pull request.

Acknowledgements

Please see our acknowledgements page.