forked from wjakethompson/taylor
-
Notifications
You must be signed in to change notification settings - Fork 0
/
README.Rmd
78 lines (56 loc) · 3.03 KB
/
README.Rmd
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
---
output: github_document
---
<!-- README.md is generated from README.Rmd. Please edit that file -->
```{r setup, include = FALSE}
library(tidyverse)
library(taylor)
knitr::opts_chunk$set(
collapse = TRUE,
comment = "#>",
fig.path = "man/figures/README-",
out.width = "100%"
)
```
# taylor
<!-- badges: start -->
[![Project Status: Active – The project has reached a stable, usable
state and is being actively
developed.](https://www.repostatus.org/badges/latest/active.svg)](https://www.repostatus.org/#active)
[![CRAN status](https://www.r-pkg.org/badges/version/taylor)](https://CRAN.R-project.org/package=taylor)
[![R-CMD-check](https://github.com/wjakethompson/taylor/workflows/R-CMD-check/badge.svg)](https://github.com/wjakethompson/taylor/actions)
[![codecov](https://codecov.io/gh/wjakethompson/taylor/branch/main/graph/badge.svg?token=TECvfoOYHh)](https://app.codecov.io/gh/wjakethompson/taylor)
![Minimal R
Version](https://img.shields.io/badge/R%3E%3D-3.6.0-blue.svg)
![License](https://img.shields.io/badge/License-MIT-blue.svg)
[![Signed
by](https://img.shields.io/badge/Keybase-Verified-brightgreen.svg)](https://keybase.io/wjakethompson)
<!-- badges: end -->
## Overview <img src="man/figures/logo.png" align="right" width="120" />
The goal of {taylor} is to provide easy access to a curated data set of Taylor Swift songs, including lyrics and audio characteristics. Data comes [Genius](https://genius.com/artists/Taylor-swift) and the [Spotify API](https://open.spotify.com/artist/06HL4z0CvFAxyc27GXpf02).
![](https://media.giphy.com/media/2tg4k9pXNcGi7kZ9Pz/giphy.gif)
## Installation
You can install the released version of {taylor} from [CRAN](https://cran.r-project.org/) with:
``` r
install.packages(taylor)
```
To install the development version from [GitHub](https://github.com/) use:
``` r
# install.packages("remotes")
remotes::install_github("wjakethompson/taylor")
```
## Example
There are three main data sets. The first is `taylor_album_songs`, which includes lyrics and audio features from the Spotify API for all songs on Taylor's official studio albums. Notably this excludes singles released separately from an album (e.g., *Only the Young*, *Christmas Tree Farm*, etc.), and non-Taylor-owned albums that have a Taylor-owned alternative (e.g., *Fearless* is excluded in favor of *Fearless (Taylor's Version)*). We stan artists owning their own songs.
```{r album-songs}
taylor_album_songs
```
You can access Taylor's entire discography with `taylor_all_songs`. This includes all of the songs in `taylor_album_songs` plus EPs, individual singles, and the original versions of albums that have been re-released as *Taylor's Version*.
```{r all-songs}
taylor_all_songs
```
Finally, there is a small data set, `taylor_albums`, summarizing Taylor's album release history.
```{r albums}
taylor_albums
```
## Code of Conduct
Please note that the {taylor} project is released with a [Contributor Code of Conduct](https://taylor.wjakethompson.com/CODE_OF_CONDUCT.html). By contributing to this project, you agree to abide by its terms.