Package 'geniusr'

Title: Tools for Working with the 'Genius' API
Description: Provides tools to interact nicely with the 'Genius' API <https://docs.genius.com/>. Search hosted content, extract associated metadata and retrieve lyrics with ease.
Authors: Ewen Henderson [aut, cre]
Maintainer: Ewen Henderson <[email protected]>
License: MIT + file LICENSE
Version: 1.2.1.9000
Built: 2025-02-12 05:27:08 UTC
Source: https://github.com/ewenme/geniusr

Help Index

Convert genius_album object to a data frame

Description

Convert genius_album object to a data frame

Usage

album_to_df(x)

Arguments

x

a genius_album object

Value

a tibble

Examples

## Not run: 
album <- get_album(album_id = 337082)
album_to_df(album)

## End(Not run)

Convert genius_artist object to a data frame

Description

Convert genius_artist object to a data frame

Usage

artist_to_df(x)

Arguments

x

a genius_artist object

Value

a tibble

Examples

## Not run: 
artist <- get_artist(artist_id = 16775)
artist_to_df(artist)

## End(Not run)

Open the Genius homepage in your browser

Description

Opens a browser to https://genius.com/.

Usage

browse_genius()

Value

A browser is opened to the Genius website if the session is interactive. The URL is returned as a character string.

Examples

browse_genius()

Open the Genius url of a resource in your browser

Description

Opens a browser to the Genius url of a Genius "resource" (i.e. the result of a successful get_album|artist|song() call).

Usage

browse_genius_resource(x)

Arguments

x

a genius_album, genius_artist, or genius_song object

Value

A browser is opened to the Genius resource's url if the session is interactive. The URL is returned as a character string.

Examples

song <- get_song(song_id = 3039923)
browse_genius_resource(song)

Get or set Genius access token value

Description

The API wrapper functions in this package all rely on a Genius client access token residing in the environment variable GENIUS_API_TOKEN. The easiest way to accomplish this is to set it in the '.Renviron' file in your home directory.

Usage

genius_token(force = FALSE)

Arguments

force

force setting a new Genius API token for the current environment?

Value

atomic character vector containing the Genius API token

Retrieve metadata for an album

Description

The Genius API lets you request data for a specific album, given an album ID. get_album() returns this data in full.

Usage

get_album(album_id, access_token = genius_token())

Arguments

album_id

ID of the album (album_id within an object returned by get_song)
access_token

Genius' client access token, defaults to genius_token

Value

a genius_album object that contains the extracted content from the request, the original JSON response object and the request path.

See Also

See get_album_df to return a tidy data frame.

Other album: get_album_df(), get_album_tracklist_id(), get_album_tracklist_search()

Examples

## Not run: 
get_album(album_id = 337082)

## End(Not run)

Retrieve meta data for an album

Description

The Genius API lets you return data for a specific album, given an album ID. get_album_meta returns this data in a tidy, but reduced, format.

Usage

get_album_df(album_id, access_token = genius_token())

Arguments

album_id

ID of the album (album_id within an object returned by get_song)
access_token

Genius' client access token, defaults to genius_token

Value

a tibble

See Also

See get_album to return extended data as a list.

Other album: get_album_tracklist_id(), get_album_tracklist_search(), get_album()

Examples

## Not run: 
get_album_df(album_id = 337082)

## End(Not run)

Retrieve an album's tracklisting

Description

Get an album's tracklisting, and song meta data, given an album ID.

Usage

get_album_tracklist_id(album_id, access_token = genius_token())

Arguments

album_id

ID of the album (album_id within an object returned by get_song)
access_token

Genius' client access token, defaults to genius_token

Value

a tibble

See Also

See get_album_tracklist_search to search for an album tracklist by searching artist/album names.

Other album: get_album_df(), get_album_tracklist_search(), get_album()

Examples

## Not run: 
get_album_tracklist_id(album_id = 337082)

## End(Not run)

Retrieve an album's tracklisting

Description

Attempt to get an album's tracklisting, given an artist and album name.

Usage

get_album_tracklist_search(artist_name, album_name)

Arguments

artist_name

Name of artist
album_name

Name of album

Value

a tibble

See Also

See get_album_tracklist_id to search for an album tracklist using an album ID.

Other album: get_album_df(), get_album_tracklist_id(), get_album()

Examples

## Not run: 
get_album_tracklist_search(artist_name = "Kendrick Lamar",
album_name = "DAMN.")

## End(Not run)

Retrieve metadata for an annotation

Description

The Genius API lets you return data for a specific annotation, given an annotation ID. get_annotation returns this data in full.

Usage

get_annotation(annotation_id, access_token = genius_token())

Arguments

annotation_id

ID of the annotation
access_token

Genius' client access token, defaults to genius_token

Details

A Genius annotation is a piece of content about a part of a document. The document may be a song (hosted on Genius) or a web page (hosted anywhere). The part of a document that an annotation is attached to is called a referent.

Value

a genius_annotation object that contains the extracted content from the request, the original JSON response object and the request path.

See Also

Other annotation: get_referent()

Examples

## Not run: 
get_annotation(annotation_id = 16511101)

## End(Not run)

Retrieve metadata for an artist

Description

The Genius API lets you return data for a specific artist, given an artist ID. get_artist returns this data in full.

Usage

get_artist(artist_id, access_token = genius_token())

Arguments

artist_id

ID of the artist (artist_id within an object returned by search_artist)
access_token

Genius' client access token, defaults to genius_token

Value

a genius_artist object that contains the extracted content from the request, the original JSON response object and the request path.

See Also

See get_artist_df to return a tidy data frame.

Other artist: get_artist_df(), get_artist_songs_df(), get_artist_songs()

Examples

## Not run: 
get_artist(artist_id = 16775)

## End(Not run)

Retrieve metadata for an artist

Description

The Genius API lets you search for meta data for an artist, given an artist ID. get_artist_df returns this data in a tidy, but reduced, format.

Usage

get_artist_df(artist_id, access_token = genius_token())

Arguments

artist_id

ID of the artist (artist_id within an object returned by search_artist)
access_token

Genius' client access token, defaults to genius_token

Value

a tibble

See Also

See get_artist to return data in full as a list.

Other artist: get_artist_songs_df(), get_artist_songs(), get_artist()

Examples

## Not run: 
get_artist_df(artist_id = 16751)

## End(Not run)

Retrieve metadata for all of an artist's songs

Description

The Genius API lets you search for song metadata of an artist, given an artist ID. get_artist_songs returns this data in full.

Usage

get_artist_songs(
  artist_id,
  sort = c("title", "popularity"),
  include_features = FALSE,
  access_token = genius_token()
)

Arguments

artist_id

ID of the artist (artist_id within an object returned by search_artist)
sort

method to order results; by "title" (default) or by "popularity"
include_features

Whether to return results where artist isn't the primary artist (logical, defaults to FALSE)
access_token

Genius' client access token, defaults to genius_token

Value

a genius_resource object that contains the extracted content from the request, the original JSON response object and the request path.

See Also

See get_artist_songs_df to return a tidy data frame.

Other artist: get_artist_df(), get_artist_songs_df(), get_artist()

Examples

## Not run: 
get_artist_songs(artist_id = 1421)
get_artist_songs(artist_id = 1421, sort = "popularity")
get_artist_songs(artist_id = 1421, include_features = TRUE)

## End(Not run)

Retrieve metadata for all of an artist's songs

Description

The Genius API lets you search for song metadata of an artist, given an artist ID. get_artist_songs_df returns this data in a tidy, but reduced, format.

Usage

get_artist_songs_df(
  artist_id,
  sort = c("title", "popularity"),
  include_features = FALSE,
  access_token = genius_token()
)

Arguments

artist_id

ID of the artist (artist_id within an object returned by search_artist)
sort

method to order results; by "title" (default) or by "popularity"
include_features

Whether to return results where artist isn't the primary artist (logical, defaults to FALSE)
access_token

Genius' client access token, defaults to genius_token

Value

a tibble

See Also

See get_artist_songs to return data in full as a list.

Other artist: get_artist_df(), get_artist_songs(), get_artist()

Examples

## Not run: 
get_artist_songs_df(artist_id = 1421)

## End(Not run)

Retrieve lyrics associated with a Genius song ID

Description

Get lyrics from Genius' lyric pages using an associated song ID.

Usage

get_lyrics_id(song_id, access_token = genius_token())

Arguments

song_id

ID of the song (song_id within an object returned by search_song)
access_token

Genius' client access token, defaults to genius_token

See Also

See get_lyrics_url to search lyrics using a song URL, get_lyrics_search to search using artist name and song title

Other lyrics: get_lyrics_search(), get_lyrics_url()

Examples

## Not run: 
get_lyrics_id(song_id = 3214267)

## End(Not run)

Retrieve lyrics associated with a Genius song

Description

Attempt to get lyrics from Genius' lyric pages using an associated artist name and song title.

Usage

get_lyrics_search(artist_name, song_title)

Arguments

artist_name

Name of artist
song_title

Title of song

See Also

See get_lyrics_id to search lyrics using a song ID, get_lyrics_url to search using a song URL

Other lyrics: get_lyrics_id(), get_lyrics_url()

Examples

## Not run: 
get_lyrics_search(artist_name = "Anderson .Paak",
song_title = "Come Home")

## End(Not run)

Retrieve lyrics associated with a Genius lyrics page URL

Description

Scrape lyrics from a Genius' lyric page using it's associated URL. Best used with get_album_tracklist_id, when song IDs aren't returned - otherwise, get_lyrics_id is recommended.

Usage

get_lyrics_url(song_lyrics_url)

Arguments

song_lyrics_url

song lyrics url (like in song_lyrics_url returned by get_song_df)

See Also

See get_lyrics_id to search lyrics using a song ID, get_lyrics_search to search using artist name and song title

Other lyrics: get_lyrics_id(), get_lyrics_search()

Examples

## Not run: 
get_lyrics_url(song_lyrics_url = "https://genius.com/Kendrick-lamar-dna-lyrics")

## End(Not run)

Retrieve metadata for a referent

Description

The Genius API lets you return data for a specific referent. get_referent returns this data in full.

Usage

get_referent(
  created_by_id,
  song_id,
  web_page_id,
  access_token = genius_token()
)

Arguments

created_by_id

ID of a user to get referents for
song_id

ID of a song to get referents for (pass only one of song_id and web_page_id)
web_page_id

ID of a web page to get referents for (pass only one of song_id and web_page_id)
access_token

Genius' client access token, defaults to genius_token

Details

Referents are the sections of a piece of content to which annotations are attached. Each referent is associated with a web page or a song and may have one or more annotations. Referents can be searched by the document they are attached to or by the user that created them.

Value

a genius_referent object that contains the extracted content from the request, the original JSON response object and the request path.

See Also

Other annotation: get_annotation()

Examples

## Not run: 
get_referent(song_id = 3039923)

## End(Not run)

Retrieve metadata for a song

Description

The Genius API lets you return data for a specific song, given a song ID. get_song returns this data in full.

Usage

get_song(song_id, access_token = genius_token())

Arguments

song_id

ID of the song (song_id within an object returned by search_song)
access_token

Genius' client access token, defaults to genius_token

Value

a genius_song object that contains the extracted content from the request, the original JSON response object and the request path.

See Also

See get_song_df to return a tidy data frame.

Other song: get_song_df(), tidy_album_performances(), tidy_song_performances(), tidy_song_producers(), tidy_song_relationships(), tidy_song_writers()

Examples

## Not run: 
get_song(song_id = 3039923)

## End(Not run)

Retrieve metadata for a song

Description

The Genius API lets you search for meta data for a song, given a song ID. get_song_meta returns this data in a tidy, but reduced, format.

Usage

get_song_df(song_id, access_token = genius_token())

Arguments

song_id

ID of the song (song_id within an object returned by search_song)
access_token

Genius' client access token, defaults to genius_token

Value

a tibble

See Also

See get_song to return data in full as a list.

Other song: get_song(), tidy_album_performances(), tidy_song_performances(), tidy_song_producers(), tidy_song_relationships(), tidy_song_writers()

Examples

## Not run: 
get_song_df(song_id = 3039923)

## End(Not run)

Slightly more human-readable output for genius_album objects

Description

Slightly more human-readable output for genius_album objects

Usage

## S3 method for class 'genius_album'
print(x, ...)

Arguments

x

a genius_album object
...

ignored

Slightly more human-readable output for genius_annotation objects

Description

Slightly more human-readable output for genius_annotation objects

Usage

## S3 method for class 'genius_annotation'
print(x, ...)

Arguments

x

a genius_annotation object
...

ignored

Slightly more human-readable output for genius_artist objects

Description

Slightly more human-readable output for genius_artist objects

Usage

## S3 method for class 'genius_artist'
print(x, ...)

Arguments

x

a genius_artist object
...

ignored

Slightly more human-readable output for genius_referent objects

Description

Slightly more human-readable output for genius_referent objects

Usage

## S3 method for class 'genius_referent'
print(x, ...)

Arguments

x

a genius_referent object
...

ignored

Slightly more human-readable output for genius_resource objects

Description

Slightly more human-readable output for genius_resource objects

Usage

## S3 method for class 'genius_resource'
print(x, ...)

Arguments

x

a genius_resource object
...

ignored

Slightly more human-readable output for genius_song objects

Description

Slightly more human-readable output for genius_song objects

Usage

## S3 method for class 'genius_song'
print(x, ...)

Arguments

x

a genius_song object
...

ignored

Search artists on Genius

Description

The Genius API lets you search hosted content (all songs). Use search_artist() to return artist_id, artist_name and artist_url for all unique artist matches found using a search term.

Usage

search_artist(search_term, n_results = 10, access_token = genius_token())

Arguments

search_term

A character string to search for
n_results

Maximum no. of search results to return
access_token

Genius' client access token, defaults to genius_token

Value

a tibble

See Also

Other search: search_genius(), search_song()

Examples

## Not run: 
search_artist(search_term = "Lil", n_results = 20)

## End(Not run)

Search documents hosted on Genius

Description

The Genius API lets you search hosted content (all songs). Use search_genius() to return hits on for a given search term, in full.

Usage

search_genius(search_term, n_results = 10, access_token = genius_token())

Arguments

search_term

A character string to search for
n_results

Maximum no. of search results to return
access_token

Genius' client access token, defaults to genius_token

Value

a genius_resource object that contains the extracted content from the request, the original JSON response object and the request path.

See Also

Other search: search_artist(), search_song()

Examples

## Not run: 
search_genius(search_term = "Lil", n_results = 100)

## End(Not run)

Search songs on Genius

Description

The Genius API lets you search hosted content (all songs). Use search_song() to return song_id, song_name, lyrics_url and artist_id for all unique song matches found using a search term.

Usage

search_song(search_term, n_results = 10, access_token = genius_token())

Arguments

search_term

A character string to search for
n_results

Maximum no. of search results to return
access_token

Genius' client access token, defaults to genius_token

Value

a tibble

See Also

Other search: search_artist(), search_genius()

Examples

## Not run: 
search_song(search_term = "Gucci", n_results = 50)

## End(Not run)

Convert genius_song object to a data frame

Description

Convert genius_song object to a data frame

Usage

song_to_df(x)

Arguments

x

a genius_song object

Value

a tibble

Examples

## Not run: 
song <- get_song(song_id = 3039923)
song_to_df(song)

## End(Not run)

Extract album performances from a Genius album

Description

Extract "album performances" (i.e. album credits) info from a Genius album object, as a tidy tibble.

Usage

tidy_album_performances(x)

Arguments

x

A genius_album object

Value

a tibble

See Also

See get_album to generate a Genius album object.

Other song: get_song_df(), get_song(), tidy_song_performances(), tidy_song_producers(), tidy_song_relationships(), tidy_song_writers()

Examples

## Not run: 
album <- get_album(album_id = 337082)

tidy_album_performances(album)

## End(Not run)

Extract custom performances from a Genius song

Description

Extract "custom performances" (i.e. other song credits) info from a Genius song object, as a tidy tibble.

Usage

tidy_song_performances(x)

Arguments

x

A genius_song object

Value

a tibble

See Also

See get_song to generate a Genius song object.

Other song: get_song_df(), get_song(), tidy_album_performances(), tidy_song_producers(), tidy_song_relationships(), tidy_song_writers()

Examples

## Not run: 
song <- get_song(song_id = 3039923)

tidy_song_performances(song)

## End(Not run)

Extract producer credits from a Genius song

Description

Extract "producer artists" (i.e. producer credits) info from a Genius song object, as a tidy tibble.

Usage

tidy_song_producers(x)

Arguments

x

A genius_song object

Value

a tibble

See Also

See get_song to generate a Genius song object.

Other song: get_song_df(), get_song(), tidy_album_performances(), tidy_song_performances(), tidy_song_relationships(), tidy_song_writers()

Examples

## Not run: 
song <- get_song(song_id = 3039923)

tidy_song_producers(song)

## End(Not run)

Extract song relationships from a Genius song

Description

Extract "song relationships" info from a Genius song object, as a tidy tibble.

Usage

tidy_song_relationships(x)

Arguments

x

A genius_song object

Value

a tibble

See Also

See get_song to generate a Genius song object.

Other song: get_song_df(), get_song(), tidy_album_performances(), tidy_song_performances(), tidy_song_producers(), tidy_song_writers()

Examples

## Not run: 
song <- get_song(song_id = 3039923)

tidy_song_relationships(song)

## End(Not run)

Extract writer credits from a Genius song

Description

Extract "writer artists" (i.e. writer credits) info from a Genius song object, as a tidy tibble.

Usage

tidy_song_writers(x)

Arguments

x

A genius_song object

Value

a tibble

See Also

See get_song to generate a Genius song object.

Other song: get_song_df(), get_song(), tidy_album_performances(), tidy_song_performances(), tidy_song_producers(), tidy_song_relationships()

Examples

## Not run: 
song <- get_song(song_id = 3039923)

tidy_song_writers(song)

## End(Not run)