Package 'vagalumeR'

Title: Access to the 'Vagalume' API
Description: Provides access to the 'Vagalume' API <https://api.vagalume.com.br>. The data extracted is basically lyrics of songs and information about artists/bands.
Authors: Bruna Wundervald
Maintainer: Bruna Wundervald <[email protected]>
License: GPL-2
Version: 0.1.6
Built: 2024-11-19 04:25:35 UTC
Source: https://github.com/r-music/vagalumer

Help Index

An artist's music albums.

Description

Gives information about the albums of an artist/band.

Usage

albums(name, message = TRUE)

Arguments

name

The name of the artist/band.
message

Should the function print something if the required data is not found?

Details

The variables returned by the function are extracted with the Vagalume API.

Value

gente returns a data.frame with information about the albums, as the id, name and year of release.

Author(s)

Bruna Wundervald, [email protected].

Examples

## Not run: 
albums("the-beatles")
albums("chico-buarque")

## End(Not run)

Artist Information

Description

Gives some information about a given artist/band.

Usage

artistInfo(name, message = TRUE)

Arguments

name

The name of the artist/band.
message

Should the function print something if the required data is not found?

Details

The variables returned by the function are extracted with the Vagalume API.

Value

artistInfo returns a data.frame with the information.

Author(s)

Bruna Wundervald, [email protected].

Examples

## Not run: 
artistInfo("the-beatles")
artistInfo("chico-buarque")

## End(Not run)

An artist's musical genre(s)

Description

Gives information about the genre (ou multiple genres) of an artist/band.

Usage

genre(name, message = TRUE)

Arguments

name

The name of the artist/band.
message

Should the function print something if the required data is not found?

Details

The variables returned by the function are extracted with the Vagalume API.

Value

genre returns a data.frame with information about the genre(s).

Author(s)

Bruna Wundervald, [email protected].

Examples

## Not run: 
genre("the-beatles")
genre("chico-buarque")

## End(Not run)

Lyrics of a song.

Description

Gives the lyrics text of a song and the translation text, when the language of the song its not Portuguese.

Usage

lyrics(identifier, type, artist, key, message = TRUE)

Arguments

identifier

The identifier of the song.
type

The type of identifier os the song ("name" or "id").
artist

The name of the artist/band.
key

The apikey.
message

Should the function print something if the required data is not found?

Details

The variables returned by the function are extracted with the Vagalume API.

Value

lyrics returns a data.frame with information about the artist, the song and the texts.

Author(s)

Bruna Wundervald, [email protected].

Examples

## Not run: 
identifier <- "A-Day-In-The-Life"
key <- "your token"
artist <- "the-beatles"
type <- "name"
lyrics(identifier, type, artist, key)

key <- "your token"
identifier <- "3ade68b4gdc96eda3"
type <- "id"
lyrics(identifier = identifier, type = type, key = key)

## End(Not run)

Artist's Related

Description

Gives information about what artists/bands are related to a specific artist/band.

Usage

relatedInfo(name, message = TRUE)

Arguments

name

The name of the artist/band.
message

Should the function print something if the required data is not found?

Details

The variables returned by the function are extracted with the Vagalume API.

Value

relatedInfo returns a data.frame with information about the related artists.

Author(s)

Bruna Wundervald, [email protected].

Examples

## Not run: 
relatedInfo("the-beatles")
relatedInfo("chico-buarque")

## End(Not run)

Song names of an artist/band.

Description

Gives information about the song names of an specific artist/band.

Usage

songNames(name, message = TRUE)

Arguments

name

The name of the artist/band.
message

Should the function print something if the required data is not found?

Details

The variables returned by the function are extracted with the Vagalume API.

Value

relatedInfo returns a data.frame with information about song names.

Author(s)

Bruna Wundervald, [email protected].

Examples

## Not run: 
songNames("the-beatles")
songNames("chico-buarque")

## End(Not run)

Top lyrics of an artist/band

Description

Gives information about the top lyrics (most viewed) about an specific artist/band.

Usage

topLyrics(name, message = TRUE)

Arguments

name

The name of the artist/band.
message

Should the function print something if the required data is not found?

Details

The variables returned by the function are extracted with the Vagalume API.

Value

topLyrics returns a data.frame with information about the top lyrics.

Author(s)

Bruna Wundervald, [email protected].

Examples

## Not run: 
topLyrics("the-beatles")
topLyrics("chico-buarque")

## End(Not run)