Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/juba/obsplot
Observable Plot bindings for R
https://github.com/juba/obsplot
Last synced: 3 months ago
JSON representation
Observable Plot bindings for R
- Host: GitHub
- URL: https://github.com/juba/obsplot
- Owner: juba
- Created: 2021-07-08T15:24:26.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2023-04-20T17:55:10.000Z (over 1 year ago)
- Last Synced: 2024-05-19T23:37:24.983Z (6 months ago)
- Language: R
- Homepage: https://juba.github.io/obsplot
- Size: 15.2 MB
- Stars: 60
- Watchers: 5
- Forks: 1
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
[](https://www.tidyverse.org/lifecycle/#maturing)
[](https://github.com/juba/obsplot/actions)
# Obsplot
> **Warning**: this project is currently not actively maintained. In particular, the current managed Plot version is 0.3.2, which is very outdated.
`obsplot` is an experimental attempt at using [Observable Plot](https://observablehq.com/@observablehq/plot) as HTML widget in R.
Please note that **the package is in an early stage**. Its API is subject to breaking changes, there are bugs, and maybe bad design choices. But if you still want to try it, issues and feedback are very welcome !
## Examples
Here is a small example of a simple scatterplot from the `penguins` dataset of the `palmerpenguins` package :
```r
library(obsplot)
library(palmerpenguins)
data(penguins)
obsplot(penguins) |>
mark_dot(x = bill_length_mm, y = bill_depth_mm, stroke = sex) |>
opts(grid = TRUE)
```
And here is a much more complex example taken from Observable Plot documentation :
```r
data(stateage)
xy <- transform_normalizeX(basis = "sum", z = "name", x = "population", y = "name")
obsplot(stateage, height = 660) |>
mark_ruleX(x = 0) |>
mark_ruleY(
transform_groupY(list(x1 = "min", x2 = "max"), xy)
) |>
mark_dot(xy, fill = age, title = age) |>
mark_text(
transform_selectMinX(xy), textAnchor = "end", dx = -6, text = name
) |>
scale_x(
axis = "top", label = "Percent (%) →",
transform = JS("d => d * 100")
) |>
scale_y(axis = NULL) |>
scale_color(scheme = "spectral", domain = unique(stateage$age)) |>
opts(grid = TRUE)
```
You will find many more examples in the two gallery vignettes :
- [marks gallery](https://juba.github.io/obsplot/articles/gallery_marks.html)
- [facets and transforms gallery](https://juba.github.io/obsplot/articles/gallery_transforms.html)
## Usage
To get started, take a look at the [introduction vignette](https://juba.github.io/obsplot/articles/introduction.html).
## Installation
From Github :
```r
remotes::install_github("juba/obsplot")
```
From [R-universe](https://r-universe.dev/organizations/) :
```r
install.packages("obsplot", repos = "https://juba.r-universe.dev")
```
## Development notes
This package uses [packer](https://github.com/JohnCoene/packer) to manage JavaScript source code and dependencies. If you want to modify it, you'll need a working installation of [Node.js](https://nodejs.org/en/).
After cloning this repository, run the following in a terminal at the project root :
```sh
npm install
```
Then, if you modify the JavaScript code in `srcjs`, you'll have to run the following command to bundle and update the widget JavaScript code :
```r
packer::bundle_dev()
```
If you want to ship a minimized production version, use :
```r
packer::bundle_prod()
```
## Credits
- Obviously, the [Observable Plot](https://observablehq.com/@observablehq/plot) library developed by [Mike Bostock](https://observablehq.com/@mbostock) and [Philippe Rivière](https://observablehq.com/@fil/) at [Observable](https://observablehq.com/).
- The [htmlwidgets](https://www.htmlwidgets.org/) package, which does all the heavy work to bridge R and JavaScript.
- [John Coene](https://twitter.com/jdatap) for the [packer](https://github.com/JohnCoene/packer) package, the [JavaScript for R](https://book.javascript-for-r.com/) book and the [g2r](https://github.com/devOpifex/g2r/) package which is a great source of inspiration.