| Title: | Access the Twitter Academic Research Product Track V2 API Endpoint |
| Version: | 0.3.1 |
| Description: | Package to query the Twitter Academic Research Product Track, providing access to full-archive search and other v2 API endpoints. Functions are written with academic research in mind. They provide flexibility in how the user wishes to store collected data, and encourage regular storage of data to mitigate loss when collecting large volumes of tweets. They also provide workarounds to manage and reshape the format in which data is provided on the client side. |
| License: | MIT + file LICENSE |
| URL: | https://github.com/cjbarrie/academictwitteR |
| BugReports: | https://github.com/cjbarrie/academictwitteR/issues |
| Encoding: | UTF-8 |
| RoxygenNote: | 7.1.2 |
| Depends: | R (≥ 3.4) |
| Imports: | dplyr (≥ 1.0.0), httr, jsonlite, magrittr, lubridate, usethis, tibble, tidyr, tidyselect, purrr, rlang, utils |
| Suggests: | knitr, rmarkdown, devtools, testthat (≥ 3.0.0), httptest, lifecycle, covr |
| VignetteBuilder: | knitr |
| Config/testthat/edition: | 3 |
| NeedsCompilation: | no |
| Packaged: | 2022-02-16 14:29:41 UTC; cbarrie6 |
| Author: | Christopher Barrie
 [aut, cre],
Justin Chun-ting Ho
[aut],
Chung-hong Chan
[ctb],
Noelia Rico [ctb],
Tim König [ctb],
Thomas Davidson
[ctb] |
| Maintainer: | Christopher Barrie <christopher.barrie@ed.ac.uk> |
| Repository: | CRAN |
| Date/Publication: | 2022-02-16 15:20:09 UTC |
Pipe operator
Description
See magrittr::%>% for details.
Usage
lhs %>% rhs
Arguments
lhs |
A value or the magrittr placeholder. |
rhs |
A function call using the magrittr semantics. |
Value
The result of calling rhs(lhs).
Bind tweets stored as JSON files 'r lifecycle::badge("deprecated")
Description
Bind tweets stored as JSON files 'r lifecycle::badge("deprecated")
Usage
bind_tweet_jsons(data_path, verbose = TRUE)
Arguments
data_path |
string, file path to directory of stored tweets data saved as data_id.json |
verbose |
If |
Value
a data.frame
Examples
## Not run:
bind_tweet_jsons(data_path = "data/")
## End(Not run)
Bind information stored as JSON files
Description
This function binds information stored as JSON files. The experimental function convert_json converts individual JSON files into either "raw" or "tidy" format.
Usage
bind_tweets(data_path, user = FALSE, verbose = TRUE, output_format = NA)
convert_json(data_file, output_format = "tidy")
Arguments
data_path |
string, file path to directory of stored tweets data saved as data_id.json and users_id.json |
user |
If |
verbose |
If |
output_format |
|
data_file |
string, a single file path to a JSON file; or a vector of file paths to JSON files of stored tweets data saved as data_id.json |
![[Experimental]](./figures/lifecycle-experimental.svg)
Details
By default, bind_tweets binds into a data frame containing tweets (from data_id.json files).
If users is TRUE, it binds into a data frame containing user information (from users_id.json).
Value
a data.frame containing either tweets or user information
Examples
## Not run:
# bind json files in the directory "data" into a data frame containing tweets
bind_tweets(data_path = "data/")
# bind json files in the directory "data" into a data frame containing user information
bind_tweets(data_path = "data/", user = TRUE)
# bind json files in the directory "data" into a "tidy" data frame / tibble
bind_tweets(data_path = "data/", user = TRUE, output_format = "tidy")
## End(Not run)
Bind user information stored as JSON files 'r lifecycle::badge("deprecated")
Description
Bind user information stored as JSON files 'r lifecycle::badge("deprecated")
Usage
bind_user_jsons(data_path, verbose = TRUE)
Arguments
data_path |
string, file path to directory of stored tweets data saved as users_id.json |
verbose |
If |
Value
a data.frame
Examples
## Not run:
bind_user_jsons("data_path = "data/"")
## End(Not run)
Build tweet query
Description
Build tweet query according to targeted parameters.
Usage
build_query(
query = NULL,
exact_phrase = NULL,
users = NULL,
reply_to = NULL,
retweets_of = NULL,
exclude = NULL,
is_retweet = NULL,
is_reply = NULL,
is_quote = NULL,
is_verified = NULL,
remove_promoted = FALSE,
has_hashtags = NULL,
has_cashtags = NULL,
has_links = NULL,
has_mentions = NULL,
has_media = NULL,
has_images = NULL,
has_videos = NULL,
has_geo = NULL,
place = NULL,
country = NULL,
point_radius = NULL,
bbox = NULL,
lang = NULL,
conversation_id = NULL,
url = NULL
)
Arguments
query |
string or character vector, search query or queries |
exact_phrase |
If |
users |
string or character vector, user handles to collect tweets from the specified users |
reply_to |
string or character vector, user handles to collect replies to the specified users |
retweets_of |
string or character vector, user handles to collects retweets of tweets by the specified users |
exclude |
string or character vector, tweets containing the keyword(s) will be excluded |
is_retweet |
If |
is_reply |
If |
is_quote |
If |
is_verified |
If |
remove_promoted |
If |
has_hashtags |
If |
has_cashtags |
If |
has_links |
If |
has_mentions |
If |
has_media |
If |
has_images |
If |
has_videos |
If |
has_geo |
If |
place |
string, name of place e.g. "London" |
country |
string, name of country as ISO alpha-2 code e.g. "GB" |
point_radius |
numeric, a vector of two point coordinates latitude, longitude, and point radius distance (in miles) |
bbox |
numeric, a vector of four bounding box coordinates from west longitude to north latitude |
lang |
string, a single BCP 47 language identifier e.g. "fr" |
conversation_id |
string, return tweets that share the specified conversation ID |
url |
string, url |
Details
This function is already called within the main
get_all_tweets function.
It may also be called separately and the output saved as
a character object query string to be input as query parameter to get_all_tweets.
Value
a query string
Examples
## Not run:
query <- build_query(query = "happy", is_retweet = FALSE,
country = "US",
place = "seattle",
point_radius = c(-122.33795253639994, 47.60900846404393, 25),
lang = "en")
query <- build_query(query = "twitter",
point_radius = c(-122.33795253639994, 47.60900846404393, 25),
lang = "en")
## End(Not run)
Count tweets from full archive search
Description
This function returns aggregate counts of tweets by query string or strings between specified date ranges.
Usage
count_all_tweets(
query = NULL,
start_tweets,
end_tweets,
bearer_token = get_bearer(),
n = 100,
file = NULL,
data_path = NULL,
export_query = TRUE,
bind_tweets = TRUE,
granularity = "day",
verbose = TRUE,
...
)
Arguments
query |
string or character vector, search query or queries |
start_tweets |
string, starting date |
end_tweets |
string, ending date |
bearer_token |
string, bearer token |
n |
integer, upper limit of tweet counts to be fetched (i.e., for 365 days n must be at least 365). Default is 100. |
file |
string, name of the resulting RDS file |
data_path |
string, if supplied, fetched data can be saved to the designated path as jsons |
export_query |
If |
bind_tweets |
If |
granularity |
string, the granularity for the search counts results. Options are "day"; "hour"; "minute". Default is day. |
verbose |
If |
... |
arguments will be passed to |
Value
a data.frame
Examples
## Not run:
count_all_tweets(query = "Hogmanay",
start_tweets = "2019-12-2700:00:00Z",
end_tweets = "2020-01-05T00:00:00Z",
bearer_token = get_bearer())
count_all_tweets(query = "Hogmanay",
start_tweets = "2019-12-27T00:00:00Z",
end_tweets = "2020-01-05T00:00:00Z",
bearer_token = get_bearer(),
granularity = "hour",
n = 500)
## End(Not run)
Create Compliance Job
Description
This function creates a new compliance job and upload the Tweet IDs or user IDs. By default, the parameter x with the length of one is assumed to be a text file containing either Tweet IDs or user IDs. This default behavior can be bypassed using force_ids For example, if you want to check for just a single Tweet ID.
Usage
create_compliance_job(
x,
type = "tweets",
bearer_token = get_bearer(),
force_ids = FALSE,
verbose = TRUE
)
Arguments
x |
either a character vector of Tweet IDs or user IDs; or a plain text file that each line contains a Tweet ID or user ID. |
type |
the type of the job, whether "tweets" or "users". |
bearer_token |
string, bearer token |
force_ids |
logical, make sure |
verbose |
If |
Value
the job ID (invisibly)
Examples
## Not run:
create_compliance_job(x = "tweetids.txt", type = "tweets")
## End(Not run)
Get tweets from full archive search
Description
This function collects tweets by query string or strings between specified date ranges.
Usage
get_all_tweets(
query = NULL,
start_tweets,
end_tweets,
bearer_token = get_bearer(),
n = 100,
file = NULL,
data_path = NULL,
export_query = TRUE,
bind_tweets = TRUE,
page_n = 500,
context_annotations = FALSE,
verbose = TRUE,
...
)
Arguments
query |
string or character vector, search query or queries |
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 |
export_query |
If |
bind_tweets |
If |
page_n |
integer, amount of tweets to be returned by per page |
context_annotations |
If |
verbose |
If |
... |
arguments will be passed to |
Details
The function can also collect tweets by users. These may be specified alongside a query string or without. When no query string is supplied, the function collects all tweets by that user.
If a filename is supplied, the function will save the result as a RDS file.
If a data path is supplied, the function will also return tweet-level data in a data/ path as a series of JSONs beginning "data_"; while user-level data will be returned as a series of JSONs beginning "users_".
Value
When bind_tweets is TRUE (default), the function returns a data frame. Nothing otherwise.
Examples
## Not run:
bearer_token <- "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
get_all_tweets(query = "BLM",
start_tweets = "2020-01-01T00:00:00Z",
end_tweets = "2020-01-05T00:00:00Z",
bearer_token = get_bearer(),
data_path = "data",
n = 500)
get_all_tweets(users = c("cbarrie", "jack"),
start_tweets = "2021-01-01T00:00:00Z",
end_tweets = "2021-06-01T00:00:00Z",
bearer_token = get_bearer(),
n = 1000)
get_all_tweets(start_tweets = "2021-01-01T00:00:00Z",
end_tweets = "2021-06-01T00:00:00Z",
bearer_token = get_bearer(),
n = 1500,
conversation_id = "1392887366507970561")
## End(Not run)
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 |
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 |
verbose |
If |
... |
arguments will be passed to |
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)
Manage bearer token
Description
This function attempts to retrieve your bearer token from the environmental variable "TWITTER_BEARER".
The easiest way to setup this environmental variable is to use set_bearer()
and insert your bearer token to .Renviron file following the format: TWITTER_BEARER=YOURTOKENHERE.
Replace YOURTOKENHERE with your own token.
Usage
get_bearer()
Details
Note: for get_bearer() to retrieve your bearer token you will need to restart the
R session after storing in .Renviron.
Value
string represents your bearer token, if it the environmental variable "TWITTER_BEARER" has been preset.
Get Compliance Result
Description
This function retrieves the information for a single compliance job.
Usage
get_compliance_result(id, bearer_token = get_bearer(), verbose = TRUE)
Arguments
id |
string, the job id |
bearer_token |
string, bearer token |
verbose |
If |
Value
a data frame
Examples
## Not run:
get_compliance_result("1460077048991555585")
## End(Not run)
Get tweets with country parameter 'r lifecycle::badge("deprecated")
Description
This function collects tweets containing strings or hashtags between specified date ranges filtering by country. 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.
Usage
get_country_tweets(
query,
country,
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 |
country |
string, name of country as ISO alpha-2 code e.g. "GB" |
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 |
verbose |
If |
... |
arguments will be passed to |
Value
a data.frame
Examples
## Not run:
bearer_token <- "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
get_country_tweets("happy", country = "GB",
"2021-01-01T00:00:00Z", "2021-01-01T00:10:00Z",
bearer_token, data_path = "data/")
## End(Not run)
Get tweets for query containing geo information 'r lifecycle::badge("deprecated")
Description
This function collects tweets containing strings or hashtags between specified date ranges that also contain Tweet-specific geolocation data provided by the Twitter user. This can be either a location in the form of a Twitter place, with the corresponding display name, geo polygon, and other fields, or in rare cases, a geo lat-long coordinate. Note: Operators matching on place (Tweet geo) will only include matches from original tweets. 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.
Usage
get_geo_tweets(
query,
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 |
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 |
verbose |
If |
... |
arguments will be passed to |
Value
a data.frame
Examples
## Not run:
bearer_token <- "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
get_geo_tweets("protest", "2020-01-01T00:00:00Z", "2020-01-05T00:00:00Z",
bearer_token, data_path = "data/")
## End(Not run)
Get tweets containing images 'r lifecycle::badge("deprecated")
Description
This function collects tweets containing strings or hashtags between specified date ranges that also contain (a recognized URL to) an image. 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.
Usage
get_image_tweets(
query,
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 |
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 |
verbose |
If |
... |
arguments will be passed to |
Value
a data.frame
Examples
## Not run:
bearer_token <- "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
get_image_tweets("#BLM", "2020-01-01T00:00:00Z", "2020-01-05T00:00:00Z",
bearer_token, data_path = "data/")
## End(Not run)
Get tweets in particular language 'r lifecycle::badge("deprecated")
Description
This function collects tweets containing strings or hashtags between specified date ranges filtering by language. 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.
Usage
get_lang_tweets(
query,
lang,
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 |
lang |
string, a single BCP 47 language identifier e.g. "fr" |
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 |
verbose |
If |
... |
arguments will be passed to |
Value
a data.frame
Examples
## Not run:
bearer_token <- "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
get_lang_tweets("bonne", lang= "fr",
"2021-01-01T00:00:00Z", "2021-01-01T00:10:00Z",
bearer_token, data_path = "data/")
## End(Not run)
Get liked tweets
Description
This function fetches returns tweets liked by a user or users.
Usage
get_liked_tweets(x, bearer_token = get_bearer(), ...)
Arguments
x |
string containing one user id or a vector of user ids |
bearer_token |
string, bearer token |
... |
arguments passed to other backend functions |
Value
a data frame
Examples
## Not run:
users <- c("2244994945", "95226101")
get_liked_tweets(users, bearer_token = get_bearer())
## End(Not run)
Get liking users
Description
This function fetches users who liked a tweet or tweets.
Usage
get_liking_users(x, bearer_token = get_bearer(), verbose = TRUE)
Arguments
x |
string containing one tweet id or a vector of tweet ids |
bearer_token |
string, bearer token |
verbose |
If |
Value
a data frame
Examples
## Not run:
tweet <- "1387744422729748486"
get_liking_users(tweet, bearer_token = get_bearer())
## End(Not run)
Get tweets for query containing media 'r lifecycle::badge("deprecated")
Description
This function collects tweets containing the strings or hashtags between specified date ranges that also contain a media object, such as a photo, GIF, or video, as determined by Twitter. 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.
Usage
get_media_tweets(
query,
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 |
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 |
verbose |
If |
... |
arguments will be passed to |
Value
a data.frame
Examples
## Not run:
bearer_token <- "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
get_media_tweets("#BLM", "2020-01-01T00:00:00Z", "2020-01-05T00:00:00Z",
bearer_token, data_path = "data/")
## End(Not run)
Get tweets for query containing mentions of another user 'r lifecycle::badge("deprecated")
Description
This function collects tweets containing strings or hashtags between specified date ranges that also contain mentions of another Twitter user. 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.
Usage
get_mentions_tweets(
query,
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 |
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 |
verbose |
If |
... |
arguments will be passed to |
Value
a data frame
Examples
## Not run:
bearer_token <- "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
get_mentions_tweets("#nowplaying", "2020-01-01T00:00:00Z", "2020-01-05T00:00:00Z",
bearer_token, data_path = "data/")
## End(Not run)
Get tweets with place parameter 'r lifecycle::badge("deprecated")
Description
This function collects tweets containing strings or hashtags between specified date ranges filtering by place. 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.
Usage
get_place_tweets(
query,
place,
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 |
place |
string, name of place e.g. "new york city" |
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 |
verbose |
If |
... |
arguments will be passed to |
Value
a data.frame
Examples
## Not run:
bearer_token <- "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
get_place_tweets("happy", place = "London",
"2021-01-01T00:00:00Z", "2021-01-01T00:10:00Z",
bearer_token, data_path = "data/")
## End(Not run)
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 |
verbose |
If |
... |
arguments will be passed to |
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/")
## End(Not run)
Get users who has retweeted a tweet
Description
This function fetches users who retweeted a tweet
Usage
get_retweeted_by(
x,
bearer_token = get_bearer(),
data_path = NULL,
verbose = TRUE
)
Arguments
x |
string containing one tweet id or a vector of tweet ids |
bearer_token |
string, bearer token |
data_path |
string, if supplied, fetched data can be saved to the designated path as jsons |
verbose |
If |
Value
a data frame
Examples
## Not run:
tweets <- c("1392887366507970561","1409931481552543749")
get_retweeted_by(tweets, bearer_token = get_bearer())
## End(Not run)
Get retweets of user 'r lifecycle::badge("deprecated")
Description
This function collects retweets of tweets by a user or set of users between specified date ranges. 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.
Usage
get_retweets_of_user(
users,
start_tweets,
end_tweets,
bearer_token = get_bearer(),
n = 100,
file = NULL,
data_path = NULL,
bind_tweets = TRUE,
verbose = TRUE,
...
)
Arguments
users |
character vector, user handles from which to collect data |
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 |
verbose |
If |
... |
arguments will be passed to |
Value
a data frame
Examples
## Not run:
bearer_token <- "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
users <- c("cbarrie", "justin_ct_ho")
get_retweets_of_user(users, "2020-01-01T00:00:00Z", "2020-04-05T00:00:00Z",
bearer_token, data_path = "data/")
## End(Not run)
Get tweets to users 'r lifecycle::badge("deprecated")
Description
This function collects tweets between specified date ranges that are in reply to the specified user(s). 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.
Usage
get_to_tweets(
users,
start_tweets,
end_tweets,
bearer_token = get_bearer(),
n = 100,
file = NULL,
data_path = NULL,
bind_tweets = TRUE,
verbose = TRUE,
...
)
Arguments
users |
character vector, user handles from which to collect data |
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 |
verbose |
If |
... |
arguments will be passed to |
Value
a data frame
Examples
## Not run:
bearer_token <- "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
users <- c("uoessps", "spsgradschool")
get_to_tweets(users, "2020-01-01T00:00:00Z", "2020-01-05T00:00:00Z",
bearer_token, data_path = "data/")
## End(Not run)
Get tweets containing URL 'r lifecycle::badge("deprecated")
Description
This function collects tweets containing a given url between specified date ranges. 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.
Usage
get_url_tweets(
query,
start_tweets,
end_tweets,
bearer_token = get_bearer(),
n = 100,
file = NULL,
data_path = NULL,
bind_tweets = TRUE,
verbose = TRUE,
...
)
Arguments
query |
string, url |
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 |
verbose |
If |
... |
arguments will be passed to |
Value
a data.frame
Examples
## Not run:
bearer_token <- "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
tweets <- get_url_tweets("https://www.theguardian.com/",
"2020-01-01T00:00:00Z", "2020-04-04T00:00:00Z", bearer_token, data_path = "data/")
## End(Not run)
Get user followers
Description
This function fetches users who are followers of the specified user ID.
Usage
get_user_followers(x, bearer_token = get_bearer(), ...)
Arguments
x |
string containing one user id or a vector of user ids |
bearer_token |
string, bearer token |
... |
arguments passed to other backend functions |
Value
a data frame
Examples
## Not run:
bearer_token <- "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
users <- "2244994945"
get_user_followers(users, bearer_token = get_bearer())
## End(Not run)
Get user following
Description
This function fetches a list of users the specified user ID is following.
Usage
get_user_following(x, bearer_token = get_bearer(), ...)
Arguments
x |
string containing one user id or a vector of user ids |
bearer_token |
string, bearer token |
... |
arguments passed to other backend functions |
Value
a data frame
Examples
## Not run:
bearer_token <- "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
users <- "2244994945"
get_user_following(users, bearer_token)
## End(Not run)
Get user id
Description
This function get the user IDs (e.g. 1349149096909668363) of given usernames, e.g. "potus".
Usage
get_user_id(
usernames,
bearer_token = get_bearer(),
all = FALSE,
keep_na = TRUE
)
Arguments
usernames |
character vector containing screen names to be queried |
bearer_token |
string, bearer token |
all |
logical, default FALSE to get a character vector of user IDs. Set it to TRUE to get a data frame, see below |
keep_na |
logical, default TRUE to keep usernames that cannot be queried. Set it to TRUE to exclude those usernames. Only useful when all is FALSE |
Value
a string vector with the id of each of the users unless all = TRUE. If all = TRUE, a data.frame with ids, names (showed on the screen) and usernames is returned.
Examples
## Not run:
bearer_token <- "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
users <- c("Twitter", "TwitterDev")
get_user_id(users, bearer_token)
## End(Not run)
Get user profile
Description
This function fetches user-level information for a vector of user IDs.
Usage
get_user_profile(x, bearer_token = get_bearer())
Arguments
x |
string containing one user id or a vector of user ids |
bearer_token |
string, bearer token |
Value
a data frame
Examples
## Not run:
bearer_token <- "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
users <- c("2244994945", "6253282")
get_user_profile(users, bearer_token)
## End(Not run)
Get tweets by a single user
Description
This function collects tweets by an user ID from the users endpoint.
Usage
get_user_timeline(
x,
start_tweets,
end_tweets,
bearer_token = get_bearer(),
n = 100,
file = NULL,
data_path = NULL,
export_query = TRUE,
bind_tweets = TRUE,
page_n = 100,
verbose = TRUE,
...
)
Arguments
x |
string containing one user id or a vector of user ids |
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 |
export_query |
If |
bind_tweets |
If |
page_n |
integer, amount of tweets to be returned by per page |
verbose |
If |
... |
arguments will be passed to |
Details
Only the most recent 3,200 Tweets can be retrieved.
If a filename is supplied, the function will save the result as a RDS file.
If a data path is supplied, the function will also return tweet-level data in a data/ path as a series of JSONs beginning "data_"; while user-level data will be returned as a series of JSONs beginning "users_".
When bind_tweets is TRUE, the function returns a data frame.
Value
a data.frame
Examples
## Not run:
get_user_timeline("2244994945",
start_tweets = "2020-01-01T00:00:00Z",
end_tweets = "2021-05-14T00:00:00Z",
bearer_token = get_bearer(),
n = 200)
## End(Not run)
Get tweets from user 'r lifecycle::badge("deprecated") This function collects tweets of a user or set of users between specified date ranges. 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.
Description
Get tweets from user 'r lifecycle::badge("deprecated")
This function collects tweets of a user or set of users between specified date ranges. 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.
Usage
get_user_tweets(
users,
start_tweets,
end_tweets,
bearer_token = get_bearer(),
n = 100,
file = NULL,
data_path = NULL,
bind_tweets = TRUE,
verbose = TRUE,
...
)
Arguments
users |
character vector, user handles from which to collect data |
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 |
verbose |
If |
... |
arguments will be passed to |
Value
a data frame
Examples
## Not run:
bearer_token <- "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
users <- c("uoessps", "spsgradschool")
get_user_tweets(users, "2020-01-01T00:00:00Z", "2020-01-05T00:00:00Z",
bearer_token, data_path = "data/")
## End(Not run)
Get tweets for query containing videos 'r lifecycle::badge("deprecated")
Description
This function collects tweets containing strings or hashtags between specified date ranges that also contain native Twitter videos, uploaded directly to Twitter. This will not match on videos created with Periscope, or Tweets with links to other video hosting sites. 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.
Usage
get_video_tweets(
query,
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 |
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 |
verbose |
If |
... |
arguments will be passed to |
Value
a data frame
Examples
## Not run:
bearer_token <- "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
get_video_tweets("#BLM", "2020-01-01T00:00:00Z", "2020-01-05T00:00:00Z",
bearer_token, data_path = "data/")
## End(Not run)
Hydrate Tweets Based On Tweet IDs
Description
This function is helpful for hydrating Tweet IDs (i.e. getting the full content of tweets from a list of Tweet IDs).
Usage
hydrate_tweets(
ids,
bearer_token = get_bearer(),
data_path = NULL,
context_annotations = FALSE,
bind_tweets = TRUE,
verbose = TRUE,
errors = FALSE
)
Arguments
ids |
a character vector of Tweet IDs |
bearer_token |
string, bearer token |
data_path |
string, if supplied, fetched data can be saved to the designated path as jsons |
context_annotations |
If |
bind_tweets |
If |
verbose |
If |
errors |
logical, if |
Details
When the error capturing mechanism is enabled, Tweets IDs that cannot be queried (e.g. with error) are stored as errors_*.json files. If bind_tweets is TRUE, those error Tweets IDs are retained in the returned data.frame with the column error indicating the error.
Value
When bind_tweets is TRUE, the function returns a data frame. The data_path (invisibly) if bind_tweets is FALSE
Examples
## Not run:
hydrate_tweets(c("1266876474440761346", "1266868259925737474", "1266867327079002121",
"1266866660713127936", "1266864490446012418", "1266860737244336129",
"1266859737615826944", "1266859455586676736", "1266858090143588352",
"1266857669157097473"))
## End(Not run)
List Compliance Jobs
Description
This function lists all compliance jobs.
Usage
list_compliance_jobs(type = "tweets", bearer_token = get_bearer())
Arguments
type |
the type of the job, whether "tweets" or "users". |
bearer_token |
string, bearer token |
Value
a data frame
Examples
## Not run:
list_compliance_jobs()
## End(Not run)
Resume previous collection
Description
This function resumes a previous interrupted collection session.
Usage
resume_collection(data_path, bearer_token = get_bearer(), verbose = TRUE, ...)
Arguments
data_path |
string, name of an existing data_path |
bearer_token |
string, bearer token |
verbose |
If |
... |
arguments will be passed to |
Details
For this function to work, export_query must be set to "TRUE" during the original collection.
Value
a data.frame
Examples
## Not run:
resume_collection(data_path = "data", bearer_token = get_bearer())
## End(Not run)
Set bearer token
Description
This function lets the user add their bearer token to the .Renviron file.
Usage
set_bearer()
Details
It is in general not safe to 1) hard code your bearer token in your R script or 2) have your bearer token in your command history.
set_bearer opens the .Renviron file
for the user and provides instructions on how to add the bearer token, which requires the
addition of just one line in the .Renviron file, following the format TWITTER_BEARER=YOURTOKENHERE.
Replace YOURTOKENHERE with your own token.
Update previous collection session
Description
This function continues a previous collection session with a new end date. For this function to work, export_query must be set to "TRUE" during the original collection.
Usage
update_collection(
data_path,
end_tweets,
bearer_token = get_bearer(),
verbose = TRUE,
...
)
Arguments
data_path |
string, name of an existing data_path |
end_tweets |
string, ending date |
bearer_token |
string, bearer token |
verbose |
If |
... |
arguments will be passed to |
Value
a data.frame
Examples
## Not run:
update_collection(data_path = "data", "2020-01-03T00:00:00Z", bearer_token = get_bearer())
## End(Not run)