get_thing: Get a comment or post based on its unique id

Description Usage Arguments Details Value Examples

Description

Get a comment or post based on its unique id

Usage

1
2
3
4
5
6
7
8
9
get_thing(
  subreddit,
  id,
  type = c("comment", "post"),
  accesstoken = NULL,
  output = c("df", "json", "all"),
  verbose = FALSE,
  retry = FALSE
)

Arguments

subreddit

The subreddit of the thing

id

The unique id of the requested thing. Reddit IDs are in base 36.

type

What type of thing the id is. Must be comment or post.

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

The requested thing 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
15
16
17
18
19
20
21
## 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)
                        

comm <- get_comments(subreddit = "askreddit",
                      accesstoken = read_token,
                      output = "df",
                      limit = 1)

#Look up the post this comment was made to
parent_post <- get_thing(subreddit = "askreddit",
                         id = comm$parent_id,
                         item_type = "post",
                         accesstoken = read_token)

## End(Not run)

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