get_user_info: Get basic information about the account of a specified user

Description Usage Arguments Details Value Examples

Description

Get basic information about the account of a specified user

Usage

1
2
3
4
5
6
7
get_user_info(
  user,
  accesstoken,
  output = c("df", "json", "all"),
  verbose = FALSE,
  retry = FALSE
)

Arguments

user

Username of the Reddit user that is requested.

accesstoken

The accesstoken required to access the endpoint. Scope must be "read".

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

Information about a specified user as a dataframe, json object or a list containing both.

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
## 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)
                        
user_info <- get_user_info(user = "_KeanuReeves",
                           accesstoken = read_token)

## End(Not run)

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