get_bbox_tweets: Get tweets within bounding box 'r...

In cjbarrie/academictwitteR: Access the Twitter Academic Research Product Track V2 API Endpoint

Get tweets within bounding box 'r lifecycle::badge("deprecated")

Description

This function collects tweets containing strings or hashtags between specified date ranges filtering by bounding box. 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 dataframe. Note: width and height of the bounding box must be less than 25mi.

Usage

get_bbox_tweets(
  query,
  bbox,
  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
bbox	numeric, a vector of four bounding box coordinates from west longitude to north latitude
start_tweets	string, starting date; default to now - 30 days
end_tweets	string, ending date; default to now - 30 seconds
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_bbox_tweets("happy", bbox= c(-0.222473,51.442453,0.072784,51.568534),
                           "2021-01-01T00:00:00Z", "2021-02-01T10:00:00Z",
                           bearer_token, data_path = "data/")

## End(Not run)

cjbarrie/academictwitteR documentation built on Dec. 20, 2024, 6:03 p.m.