README.Rmd

---
output: github_document
---

<!-- README.md is generated from README.Rmd. Please edit that file -->

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

# friends <img src='man/figures/logo.png' align="right" height="139" />

<!-- badges: start -->
[![R-CMD-check](https://github.com/EmilHvitfeldt/friends/workflows/R-CMD-check/badge.svg)](https://github.com/EmilHvitfeldt/friends/actions)
[![CRAN status](http://www.r-pkg.org/badges/version/friends)](https://CRAN.R-project.org/package=friends)
[![Downloads](http://cranlogs.r-pkg.org/badges/friends)](https://CRAN.R-project.org/package=friends)
[![Lifecycle: stable](https://img.shields.io/badge/lifecycle-stable-brightgreen.svg)](https://www.tidyverse.org/lifecycle/#stable)
<!-- badges: end -->

The goal of friends to provide the complete script transcription of the [Friends](https://en.wikipedia.org/wiki/Friends) sitcom. The data originates from the [Character Mining](https://github.com/emorynlp/character-mining) repository which includes references to scientific explorations using this data. This package simply provides the data in tibble format instead of json files.

## Installation

You can install the released version of friends from [CRAN](https://CRAN.R-project.org) with:

``` r
install.packages("friends")
```

And the development version from [GitHub](https://github.com/) with:

``` r
# install.packages("devtools")
devtools::install_github("EmilHvitfeldt/friends")
```

## Example

The friends package comes with a couple of datasets. The main one is the `friends` dataset which is a tibble containing all the utterances in the show

```{r example}
library(friends)

friends
```

All the utterances are broken down by `season`, `episode`, `scene` and `utterance` which allows for very detailed analysis. Please note that the `speaker` will be denoted `"Scene Directions"` to show scene directions, or otherwise non-spoken descriptions.

The original data includes emotion and character entity annotation for some of the utterances. These annotations have been included in separate tibbles. These can easily be joined back to the main dataset as needed.

```{r}
friends_entities

friends_emotions
```

There is also a tibble containing episode specific information such as `title`, `air_date` and `imdb_rating`

```{r}
friends_info
```

## Code of Conduct

Please note that the friends project is released with a [Contributor Code of Conduct](https://contributor-covenant.org/version/2/0/CODE_OF_CONDUCT.html). By contributing to this project, you agree to abide by its terms.