user_lists: Get a user's lists

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

Get a user's lists

Description

Retrieve all lists a user has created together with information about the user. Use extended = "full" to retrieve all user profile data, similiar to user_profile. The returned variables trakt (list ID) or slug (list slug) can be used to retrieve the list's items via user_list_items.

Usage

user_lists(user = getOption("trakt_username"), extended = c("min", "full"))

Arguments

user	character(1): Target username (or slug). Defaults to getOption("trakt_username"). Can also be of length greater than 1, in which case the function is called on all user values separately and the result is combined.
extended	character(1): Either "min" (API default) or "full". The latter returns more variables and should generally only be used if required. See vignette("finding-things") for more details.

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

In the embedded user data, name is renamed to user_name due to duplication with e.g. list names, and slug is renamed to user_slug for the same reason.

Source

user_lists() wraps endpoint users/:id/lists.

See Also

user_lists for all lists a user has.

user_list_items For the actual content of a list.

Other list methods: lists_popular(), media_lists, user_list(), user_list_comments(), user_list_items()

Examples

## Not run: 
user_lists("jemus42")

## End(Not run)

jemus42/tRakt documentation built on May 4, 2024, 9:21 a.m.