media_ratings: Media user ratings

In jemus42/tRakt: Get Data from 'trakt.tv'

Media user ratings

Description

Returns a movie's or show's (or season's, or episode's) rating and ratings distribution. If you do not want the full ratings distribution, it is highly advised to just use ⁠*_summary⁠ functions or seasons_season for episode ratings.

Usage

shows_ratings(id)

movies_ratings(id)

seasons_ratings(id, season = 1L)

episodes_ratings(id, season = 1L, episode = 1L)

Arguments

id	character(1): The ID of the item requested. Preferably the trakt ID (e.g. 1429). Other options are the trakt.tv slug (e.g. "the-wire") or imdb ID (e.g. "tt0306414"). Can also be of length greater than 1, in which case the function is called on all id values separately and the result is combined. See vignette("finding-things") for more details.
season, episode	integer(1) [1L]: The season and eisode number. If longer, e.g. 1:5, the function is vectorized and the output will be combined. This may result in a lot of API calls. Use wisely.

Value

A tibble(). If the function has a limit parameter (defaulting to 10), this will be the (maximum) number of rows of the tibble. If there are no results (or the API is unreachable), an empty tibble() is returned.

Note

Since this function is able to work on multi-length inputs for id, season and episode, it is possible to get a lot of data, but at the cost of one API call per element in each argument. Please be kind to the API.

Source

shows_ratings() wraps endpoint shows/:ids/ratings.

movies_ratings() wraps endpoint movies/:id/ratings.

seasons_ratings() wraps endpoint shows/:id/seasons/:season/ratings.

episodes_ratings() wraps endpoint shows/:id/seasons/:season/episodes/:episode/ratings.

See Also

Other show data: collected_media, media_aliases, media_comments, media_lists, media_people, media_stats(), media_translations, media_watching, people_media(), played_media, shows_next_episode(), shows_related(), shows_summary()

Other movie data: anticipated_media, collected_media, media_aliases, media_comments, media_lists, media_people, media_stats(), media_translations, media_watching, movies_boxoffice(), movies_related(), movies_releases(), movies_summary(), people_media(), played_media, popular_media, trending_media, watched_media

Other season data: media_comments, media_lists, media_people, media_stats(), seasons_season(), seasons_summary()

Other episode data: episodes_summary(), media_comments, media_lists, media_people, media_stats(), media_translations, media_watching, seasons_season(), seasons_summary(), shows_next_episode()

Examples

# A movie's ratings
movies_ratings("tron-legacy-2010")

# A show's ratings
shows_ratings("game-of-thrones")
## Not run: 
# Ratings for seasons 1 through 5
seasons_ratings("futurama", season = 1:5)

# Ratings for episodes 1 through 7 of season 1
episodes_ratings("futurama", season = 1, episode = 1:7)

## End(Not run)

jemus42/tRakt documentation built on April 19, 2024, 3:25 a.m.