https://github.com/idyll-lang/idyll-plugin-runscripts

Inline script execution for idyll documents
https://github.com/idyll-lang/idyll-plugin-runscripts

Last synced: 14 days ago
JSON representation

Inline script execution for idyll documents

• Host: GitHub
• URL: https://github.com/idyll-lang/idyll-plugin-runscripts
• Owner: idyll-lang
• Created: 2019-04-22T21:59:22.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2019-04-22T22:12:26.000Z (over 5 years ago)
• Last Synced: 2024-10-30T00:54:57.741Z (21 days ago)
• Language: JavaScript
• Size: 141 KB
• Stars: 4
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        


# Idyll RunScripts plugin

The purpose of this plugin is to enable you to embed scripts in your Idyll markup that run at compile time.

For example, this Idyll markup runs R code to generate an inline chart in the idyll output:

````

# Introduction

```exec:rstats

library(ggplot2)

ggplot(airquality, aes(Temp, Ozone)) +

        geom_point() +

        geom_smooth(method = "loess", se = FALSE)

```

````

![output](./docs/images/output.png)

At this point in time consider this plugin experimental. It is very rudimentary and is primarily meant to serve

as a proof of concept to see if people are interested in this functionality. If they are we can expand on it.

## Installation

```

$ npm install --save-dev idyll-plugin-runscripts

```

Add it to your idyll configuration in `package.json`:

```json

"idyll": {

  "compiler": {

    "postProcessors": ["idyll-plugin-runscripts"]

  }

}

```

## Supported languages

At the moment we only support R, but others could be added in the future.

### R

The R support assumes that you will be creating some sort of graphical output using the

default built-in graphics device.

In order for this to work, you need to make sure the `Rscript` binary is available on your system

and that you are creating one plot per code cell, not using any custom filenames.