get_users: Get user accounts

In jfeldhege/redditoR: Access the Reddit API

Description

Searches for popular or new users and returns them as a dataframe.

Usage

get_users(
  type = c("popular", "new"),
  accesstoken,
  limit = 100,
  after = NULL,
  before = NULL,
  output = c("df", "json", "all"),
  verbose = FALSE,
  retry = FALSE
)

Arguments

type	The type of users that is requested. Possible values are: popular User accounts that are popular right now new Newly created user accounts
accesstoken	The accesstoken required to access the endpoint. Scope must be "read".
limit	The maximum number of users to return. Must be a number between 1 and 100.
after	The fullname of an item serving as anchor in the request. Items after this item in the listing are returned.
before	The fullname of an item serving as anchor in the request. Items before this item in the listing are returned.
output	What the function should return. Choose json for an unparsed json object, df for a parsed object in form of a dataframe, and all for a list containg the json object, a dataframe, and the before and after anchors (if those exist for the endpoint).
verbose	A logical flag whether information about the data extraction should be printed to the console.
retry	A logical flag whether a failed api request should be retried. Requests will be tried up to three times with varying time intervals between requests.

Details

More info at https://www.reddit.com/dev/api/

Value

New or popular users as a dataframe, json object or a list containing both.

Examples

## Not run: 
read_token <- get_token(scope = "read",
                        useragent = my_useragent,
                        username = my_username,
                        password = my_password,
                        client_id = my_client_id,
                        client_secret = my_client_secret)
                        
#Find popular users
popular_users <- get_users(type = "popular",
                           accesstoken = read_token,
                           limit = 10)
#Find new user accounts
new_users <- get_users(type = "new",
                      accesstoken = read_token,
                      limit = 100)

## End(Not run)

jfeldhege/redditoR documentation built on April 2, 2020, 9:42 p.m.