https://github.com/jonthegeek/robodeck

Quickly Generate Slide Decks with AI
https://github.com/jonthegeek/robodeck

Last synced: 10 days ago
JSON representation

Quickly Generate Slide Decks with AI

• Host: GitHub
• URL: https://github.com/jonthegeek/robodeck
• Owner: jonthegeek
• License: other
• Created: 2024-03-09T16:48:38.000Z (8 months ago)
• Default Branch: main
• Last Pushed: 2024-05-20T14:36:02.000Z (6 months ago)
• Last Synced: 2024-08-13T07:11:10.853Z (3 months ago)
• Language: R
• Homepage: https://jonthegeek.github.io/robodeck/
• Size: 4.99 MB
• Stars: 11
• Watchers: 3
• Forks: 2
• Open Issues: 9
• Metadata Files:
  • Readme: README.Rmd
  • Contributing: .github/CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: .github/CODE_OF_CONDUCT.md
  • Support: .github/SUPPORT.md

Awesome Lists containing this project

• jimsghstars - jonthegeek/robodeck - Quickly Generate Slide Decks with AI (R)

README

        
---

output: github_document

---

```{r, include = FALSE}

knitr::opts_chunk$set(

  collapse = TRUE,

  comment = "#>",

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

  out.width = "100%"

)

```

# robodeck 

[![Lifecycle: experimental](https://img.shields.io/badge/lifecycle-experimental-orange.svg)](https://lifecycle.r-lib.org/articles/stages.html#experimental)

[![CRAN status](https://www.r-pkg.org/badges/version/robodeck)](https://CRAN.R-project.org/package=robodeck)

[![Codecov test coverage](https://codecov.io/gh/jonthegeek/robodeck/branch/main/graph/badge.svg)](https://app.codecov.io/gh/jonthegeek/robodeck?branch=main)

[![R-CMD-check](https://github.com/jonthegeek/robodeck/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/jonthegeek/robodeck/actions/workflows/R-CMD-check.yaml)

Sometimes it's easier to *edit* a deck than to *create* one from scratch.

Enter robodeck!

This extremely experimental package uses the [OpenAI API](https://platform.openai.com/docs/api-reference/) to generate Quarto slide decks quickly.

## Installation

You can install the development version of robodeck from [GitHub](https://github.com/) with:

``` r

# 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.

```{r full-deck}

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

)

```

```{r full-deck-result, echo=FALSE}

paste("| ", stringr::str_split_1(deck_markdown, "\n")) |> 

  cat(sep = "\n")

```

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](https://jonthegeek.github.io/robodeck/CODE_OF_CONDUCT.html). By contributing to this project, you agree to abide by its terms.