Get a single list

Retrieve a single list 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_list(
  user = getOption("trakt_username"),
  list_id,
  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.

list_id

The list identifier, either trakt ID or slug of the list. Can be optained via the website (URL slug) or e.g. user_lists.

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.

See also

user_list for only a single list.

user_list_items For the actual content of a list.

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

Examples

if (FALSE) { # \dontrun{
user_list("jemus42", list_id = 2121308)
} # }