In mcguinlu/nightvale: Access Welcome to Night Vale Proverbs

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

nightvale

Background

Welcome to Night Vale is a twice-monthly podcast in the style of community updates for the small desert town of Night Vale, with heavy themes of surreal humor and horror. A key and recurring part of the show is "Today's Proverb". This package provides the metadata and proverb for each episode as a dataset, in addition to a function to return a nicely formatted proverb to the console.

Installation

This package is a GitHub only package, and can be installed using:

``` {r, eval = FALSE}

install.packages("devtools")

devtools::install_github("mcguinlu/nightvale")

## Usage

### Access the data

```r
library(nightvale)

head(proverb_data)

Get a random proverb

proverb()

Get a specific proverb

proverb(22)

Git Scraping

The Welcome to Night Vale podcast continues to release a new show every two weeks. In order to capture the proverbs from these new episodes, this project also contains a GitHub Action that automatically re-scrapes the community-maintained table of proverbs every week. When new proverbs are identified, the proverb dataset included as part of this package is updated.

To get the most up-to-date version of the proverb dataset, simply re-install the package using:

{r, eval = FALSE} devtools::install_github("mcguinlu/nightvale")

mcguinlu/nightvale documentation built on April 24, 2023, 4:19 p.m.