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

https://github.com/tadascience/valentine

❤️ Spread the love for R packages with poetry 🌹
https://github.com/tadascience/valentine

ai chatgpt ellmer love poetry r-package valentine valentine-day

Last synced: 8 months ago
JSON representation

❤️ Spread the love for R packages with poetry 🌹

Awesome Lists containing this project

README

          

---
output: github_document
---

```{r, include = FALSE}
knitr::opts_chunk$set(
collapse = TRUE,
comment = "#>",
fig.path = "man/figures/README-",
out.width = "100%"
)
```

# valentine

[![CRAN status](https://www.r-pkg.org/badges/version/valentine)](https://CRAN.R-project.org/package=valentine)
[![R-CMD-check](https://github.com/tadascience/valentine/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/tadascience/valentine/actions/workflows/R-CMD-check.yaml)

The goal of valentine is to spread the love 💛 about your
favourite R package via "roses are red ... " poems 🌹 generated
by AI via the [ellmer](https://ellmer.tidyverse.org/) 📦.

## Installation

You can install the development version:

``` r
pak::pak("tadascience/valentine")
```

## Setup

`valentine::roses()` uses a [Chat](https://ellmer.tidyverse.org/reference/Chat.html)
object to communicate with the LLM of your choice. The default
value for the `chat` argument uses the "gpt-3.5-turbo" model from OpenAI via the
[ellmer::chat_openai()](https://ellmer.tidyverse.org/reference/chat_openai.html)
which is usually good enough for such a simple task.

Please refer to [ellmer](https://ellmer.tidyverse.org/index.html) documentation
for information on setting up api keys, etc ...

## Example

```{r example}
valentine::roses("dplyr")
valentine::roses("lubridate", hint = "make it kinky")
valentine::roses("valentine")
```