lookup_collections: Get collections by user or status id.

Description Usage Arguments Value Examples

View source: R/collections.R

Description

Return data for specified collection (themed grouping of Twitter statuses). Response data varies significantly compared to most other users and tweets data objects returned in this package.

Usage

1
lookup_collections(id, n = 200, parse = TRUE, token = NULL, ...)

Arguments

id

required. The identifier of the Collection to return results for e.g., "custom-539487832448843776"

n

Specifies the maximum number of results to include in the response. Specify count between 1 and 200.

parse

Logical indicating whether to convert response object into nested list. Defaults to true.

token

Every user should have their own Oauth (Twitter API) token. By default token = NULL this function looks for the path to a saved Twitter token via environment variables (which is what 'create_token()' sets up by default during initial token creation). For instruction on how to create a Twitter token see the tokens vignette, i.e., 'vignettes("auth", "rtweet")' or see ?tokens.

...

Other arguments passed along to composed request query.

Value

Return object converted to nested list if parsed otherwise an HTTP response object is returned.

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
## Not run: 

## lookup a specific collection
cc <- lookup_collections("custom-539487832448843776")

## inspect data
str(cc)


## End(Not run)

rtweet documentation built on Jan. 11, 2020, 9:11 a.m.