jonthegeek / robodeck

Quickly Generate Slide Decks with AI

Home Page:https://jonthegeek.github.io/robodeck/

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

robodeck robodeck website

Lifecycle: experimental CRAN status Codecov test coverage R-CMD-check

Sometimes it’s easier to edit a deck than to create one from scratch. Enter robodeck!

This extremely experimental package uses the OpenAI API to generate Quarto slide decks quickly.

Installation

You can install the development version of robodeck from GitHub with:

# install.packages("pak")
pak::pak("jonthegeek/robodeck")

Usage

We do not recommend using the output of this package without editing. That said, the deck below was generated without editing, as an example.

library(robodeck)
description <- 
  "robodeck is an R package that utilizes the OpenAI API 
   (https://platform.openai.com/docs/api-reference/) to quickly generate Quarto 
   slide decks. In this lightning talk I will demonstrate how to use 
   robodeck::gen_deck() to automatically generate a slide deck from just a title 
   and description, and why you should carefully edit the results!" |> 
  stringr::str_squish()

# Store an API key in an environment variable called OPENAI_API_KEY.

deck_markdown <- gen_deck(
  title = "Introducing robodeck",
  description = description,
  minutes = 5
)
#> |  # Demonstration
#> |  
#> |  ---
#> |  
#> |  ## Generating a basic slide deck with robodeck
#> |  
#> |  ```{r}
#> |  # Generate a basic slide deck with robodeck::gen_deck()
#> |  ```
#> |  
#> |  ![A robot assembling slides](robot.png)
#> |  
#> |  - 👾 Simply call `robodeck::gen_deck()` to create a slide deck automatically!
#> |  
#> |  ---
#> |  
#> |  ## Viewing the automatically generated slide content
#> |  
#> |  ```{r}
#> |  # View the automatically generated slide content
#> |  ```
#> |  
#> |  ![A computer screen displaying slides](slides.png)
#> |  
#> |  - 👀 Check out the slides generated from just a title and description!
#> |  
#> |  ---
#> |  
#> |  # Editing Best Practices
#> |  
#> |  ---
#> |  
#> |  ## Reviewing and refining slide content
#> |  
#> |  ```{r}
#> |  # Reviewing and refining automatically generated content
#> |  ```
#> |  
#> |  ![A magnifying glass inspecting slides](magnifying.png)
#> |  
#> |  - 🧐 Take a closer look at the content and make necessary adjustments!
#> |  
#> |  ---
#> |  
#> |  ## Adding personal touches and customizations
#> |  
#> |  ```{r}
#> |  # Adding personal touches and customizations
#> |  ```
#> |  
#> |  ![A paintbrush adding custom elements to slides](paintbrush.png)
#> |  
#> |  - 🎨 Add your personal flair and make the slide deck uniquely yours!

Note that function calls will hit the OpenAI API, which is not free. At the time of this writing, experiments with the API while writing this package have incurred a total cost of about $0.13, almost all of that while experimenting with the more expensive “GPT-4-turbo” API. By default, robodeck uses the “GPT-3.5-turbo” API, which should cost <$0.01 to generate a deck.

Code of Conduct

Please note that the robodeck project is released with a Contributor Code of Conduct. By contributing to this project, you agree to abide by its terms.

About

Quickly Generate Slide Decks with AI

https://jonthegeek.github.io/robodeck/

License:Other


Languages

Language:R 100.0%