get_comments: Get comments from a specified subreddit

Description Usage Arguments Details Value Examples

Description

Get comments from a specified subreddit

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
get_comments(
  subreddit,
  accesstoken,
  limit = 100,
  before = NULL,
  after = NULL,
  output = c("df", "json", "all"),
  verbose = FALSE,
  retry = FALSE
)

Arguments

subreddit

The name of the subreddit from which comments are requested

accesstoken

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

limit

The maximum number of comments to return. Must be a number between 1 and 100.

before

The fullname of a comment serving as anchor in the request. Comments before this comment in the listing are returned.

after

The fullname of a comment serving as anchor in the request. Comments after this comment 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 comments from a specified subreddit as a dataframe, json object or a list containing both.

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
## 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)
                        
#10 new comments from subreddit askreddit
comms <- get_comments(subreddit = "askreddit",
                      accesstoken = read_token,
                      limit = 10)

## End(Not run)

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