academictwitteR (version 0.3.1)

get_radius_tweets: Get tweets within radius buffer `r lifecycle::badge("deprecated")

Description

This function collects tweets containing strings or hashtags between specified date ranges filtering by radius buffer. Tweet-level data is stored in a data/ path as a series of JSONs beginning "data_"; User-level data is stored as a series of JSONs beginning "users_". If a filename is supplied, this function will save the result as a RDS file, otherwise it will return the results as a data.frame. Note: radius must be less than 25mi.

Usage

get_radius_tweets(
  query,
  radius,
  start_tweets,
  end_tweets,
  bearer_token = get_bearer(),
  n = 100,
  file = NULL,
  data_path = NULL,
  bind_tweets = TRUE,
  verbose = TRUE,
  ...
)

Arguments

query

string or character vector, search query or queries

radius

numeric, a vector of two point coordinates latitude, longitude, and point radius distance (in miles)

start_tweets

string, starting date

end_tweets

string, ending date

bearer_token

string, bearer token

n

integer, upper limit of tweets to be fetched

file

string, name of the resulting RDS file

data_path

string, if supplied, fetched data can be saved to the designated path as jsons

bind_tweets

If TRUE, tweets captured are bound into a data.frame for assignment

verbose

If FALSE, query progress messages are suppressed

...

arguments will be passed to build_query() function. See ?build_query() for further information.

Value

a data.frame

Examples

# NOT RUN {
bearer_token <- "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
tweets <- get_radius_tweets("happy", radius = c(-0.131969125179604,51.50847878040284, 25),
                           start_tweets = "2021-01-01T00:00:00Z",
                           end_tweets = "2021-01-01T10:00:00Z",
                           bearer_token = bearer_token, data_path = "data/")
# }