Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

https://github.com/coolbutuseless/devoutrgl

R graphics device to render to {rgl}
https://github.com/coolbutuseless/devoutrgl

Last synced: 3 months ago
JSON representation

R graphics device to render to {rgl}

Lists

README 

        
---

output: github_document

---



```{r, include = FALSE}

knitr::opts_chunk$set(

  collapse = TRUE,

  comment = "#>",

  fig.path = "man/figures/README-",

  out.width = "100%"

)



library(ggraph)

library(tidygraph)

library(dplyr)

library(sf)



library(rgl)

library(knitr)

library(ggplot2)

library(devoutrgl)



set.seed(1)

```



```{r echo = FALSE, eval = FALSE}

if (FALSE) {

  pkgdown::build_site(override = list(destination = "../coolbutuseless.github.io/package/devoutrgl"))

}

```



# devoutrgl   



![](https://img.shields.io/badge/cool-useless-green.svg)

![](http://img.shields.io/badge/dev-out-blue.svg)

[![Lifecycle: experimental](https://img.shields.io/badge/lifecycle-experimental-orange.svg)](https://www.tidyverse.org/lifecycle/#experimental)



`devoutrgl::rgldev()` is a graphics device - like `pdf()` or `png()`.  This device

will render a plot as an interactive 3d opengl document using `{rgl}`.



**NOTE: Since Github does not allow webgl rendering in README files, all plots 

on GitHub have been rendered as PNGs or animated gifs. Please

visit [the package website](https://coolbutuseless.github.io/package/devoutrgl)

to interact with the generated output in the vignettes**



## What's in the box:



* `rgldev()` is the rgl device. Use it like you would use the `pdf()` device or the

  `png()` device.



## Installation



You can install from [GitHub](https://github.com/coolbutuseless/devoutrgl) with:



``` r

# install.packages("remotes")

remotes::install_github("coolbutuseless/snowcrash")  # Store R objects as images

remotes::install_github("coolbutuseless/cryogenic")  # Freeze R calls + replay

remotes::install_github("coolbutuseless/triangular") # Polygon Triangulation

remotes::install_github("coolbutuseless/devout")     # R device framework

remotes::install_github("coolbutuseless/devoutrgl")  # This device

```



    

## Limitations



* No font selection. Everything will be in the default sans serif!

* Multi-line text in a single string with "\n" characters does not render well.

* No support for clipping paths.



# Examples



Bar Plot

------------------------------------------------------------------------------



```{r eval=FALSE}

library(ggplot2)

library(devoutrgl)



plot_df <- data.frame(x=c('a', 'b', 'c'), y=4:6)

p <- ggplot(plot_df) +

  geom_bar(aes(x, y, fill=x), colour = NA, stat='identity') +

  labs(title = "{devoutrgl}") +

  scale_fill_brewer(type = 'seq', palette = 'Blues') + 

  theme_minimal() + theme_rgl()



devoutrgl::rgldev(fov = 30, view_angle = -30)

p

invisible(dev.off())

```



View an interactive version of this plot in the online documentation






Base plot

------------------------------------------------------------------------------



```{r eval = FALSE}

devoutrgl::rgldev(fov = 30, view = 'flat', view_angle = 30, zoom = 0.6, filename = "man/figures/pie.png") 

pie(c(cool=1, but = 2, use=3, less = 4))

dev.off()

```



View an interactive version of this plot in the online documentation






Polygon with a hole

------------------------------------------------------------------------------



# Polygon with a hole



```{r}

#~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

# polygons_df - data.frame of polygon vertices with group/subgroups

#~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

polygons_df <- df <- data.frame(

  x        = c(4, 8, 8, 4,   6, 7, 7, 6),

  y        = c(4, 4, 8, 8,   6, 6, 7, 7),

  group    = c(1, 1, 1, 1,   1, 1, 1, 1),

  subgroup = c(1, 1, 1, 1,   2, 2, 2, 2)

)



#~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

# Plot

#~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

p <- ggplot(polygons_df) +

  geom_polygon(aes(x, y, group=group, subgroup=subgroup)) +

  geom_path(aes(x, y, group = interaction(group, subgroup)), colour = 'red') +

  theme_bw() + 

  coord_equal() + 

  labs(title = "{devoutrgl} polygon with a hole")



rgldev(fov = 30, view_angle = -30, zoom = 0.8)

p

invisible(dev.off())

```



View an interactive version of this plot in the online documentation



```{r echo=FALSE, eval=FALSE}

save_animated_scene("man/figures/polygon-with-hole.gif")

# system('ffmpeg -i man/figures/density.gif -movflags faststart -pix_fmt yuv420p -vf "scale=trunc(iw/2)*2:trunc(ih/2)*2" man/figures/polygon-with-hole.mp4')

```






Density Plot

------------------------------------------------------------------------------



```{r eval=FALSE}

library(ggplot2)

library(devoutrgl)



p <- ggplot(mtcars) +

  geom_density(aes(mpg, fill=as.factor(cyl)), colour = '#ffffff00') +

  theme(legend.position = 'none') +

  scale_fill_brewer(palette = 'Set1') + 

  theme_bw() +

  labs(title = "{devoutrgl} geom_density()")



rgldev(fov = 30, view_angle = 30)

p

invisible(dev.off())

```



View an interactive version of this plot in the online documentation



```{r echo=FALSE, eval=FALSE}

save_animated_scene("man/figures/density.gif")

# system('ffmpeg -i man/figures/density.gif -movflags faststart -pix_fmt yuv420p -vf "scale=trunc(iw/2)*2:trunc(ih/2)*2" man/figures/density.mp4')

```






Generating the logo for this package

------------------------------------------------------------------------------



```{r eval = FALSE}

library(ggplot2)

library(dplyr)



hex_df <- tibble(

  rad = seq(0, 2*pi, pi/3),

  x   = sin(rad),

  y   = cos(rad)

)



p <- ggplot(hex_df) +

  geom_polygon(aes(x, y), fill = '#002366', colour = '#436B9530') +

  annotate('text', x = 0, y = 0, label = "/dev/out/\n\n\nrgl", size = 20, color = 'grey90') +

  coord_fixed() +

  theme_minimal(25) + 

  theme(panel.grid = element_blank())



devoutrgl::rgldev(

  width       = 5.5,

  fov         = 30,

  view3d_args = list(-45, 0, zoom = 0.8),

  dpi         = 300,

  filename    = "man/figures/logo-new.png"

)



p

invisible(dev.off())

```



View an interactive version of this plot in the online documentation