Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/vosonlab/voson.tcn
R package for collecting threaded twitter conversations and generating networks.
https://github.com/vosonlab/voson.tcn
conversations rstats sna twitter voson
Last synced: about 3 hours ago
JSON representation
R package for collecting threaded twitter conversations and generating networks.
- Host: GitHub
- URL: https://github.com/vosonlab/voson.tcn
- Owner: vosonlab
- License: gpl-3.0
- Created: 2021-03-04T01:39:50.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2022-08-30T13:58:27.000Z (about 2 years ago)
- Last Synced: 2023-11-20T16:01:33.002Z (12 months ago)
- Topics: conversations, rstats, sna, twitter, voson
- Language: R
- Homepage: https://vosonlab.github.io/voson.tcn
- Size: 769 KB
- Stars: 9
- Watchers: 3
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.Rmd
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
---
output: github_document
---
```{r setup, include=FALSE}
knitr::opts_chunk$set(echo = TRUE, collapse = TRUE)
pkg <- "voson.tcn"
```
# voson.tcn - Twitter Conversation Networks
[](https://developer.twitter.com/en/docs/twitter-api)
[](https://CRAN.R-project.org/package=`r pkg`)
[](https://CRAN.R-project.org/package=`r pkg`)
[](https://CRAN.R-project.org/package=`r pkg`)
[](https://github.com/vosonlab/`r pkg`/releases)
[`&logo=github)](https://github.com/vosonlab/`r pkg`)
[](https://github.com/vosonlab/`r pkg`/commits/main)
[](https://github.com/vosonlab/`r pkg`/actions)
Twitter Conversation Networks and Analysis. This package uses the Twitter API v2 endpoints to collect tweets and generate networks for threaded conversations identified using the new tweet [conversation identifier](https://developer.twitter.com/en/docs/twitter-api/conversation-id).
An introduction to the Twitter API v2 can be found [here](https://developer.twitter.com/en/docs/twitter-api/getting-started/about-twitter-api), and the Twitter Developer Application process [here](https://developer.twitter.com/en/docs/twitter-api/getting-started/getting-access-to-the-twitter-api).
## Installation Options
Install the most recent CRAN release:
``` r
install.packages("`r pkg`")
```
```{r release, include=FALSE}
dl_url <- NULL
if (all(sapply(c("httr", "dplyr", "jsonlite", "tidyr"), require, character.only = TRUE))) {
rel_resp <- GET(paste0("https://api.github.com/repos/vosonlab/", pkg, "/releases"),
add_headers(Accept = "application/vnd.github.v3+json"))
if (rel_resp$status_code == 200) {
resp_content <- fromJSON(rawToChar(rel_resp$content))
if ("tag_name" %in% names(resp_content)) {
meta <- select(slice_head(resp_content), tag_name, tarball_url, assets)
assets <- meta |> select(assets) |> unnest(cols = c(assets))
dl_url <- assets |> pull(browser_download_url)
rel_inst <- paste0("Install the most recent release tag via GitHub:\n\n",
"``` r\n",
"install.packages(\n",
" \"", dl_url, "\",\n",
" repo = NULL, type = \"source\")\n",
"```\n")
}
}
}
```
`r if(!is.null(dl_url)) rel_inst`
Install the latest development version:
``` r
# library(remotes)
remotes::install_github("vosonlab/`r pkg`")
```
### OAuth Authentication
This package currently uses app based authentication approach with an `OAuth2` bearer token rather than a user based one that uses an `OAuth1a` token. Bearer tokens have read-only API access and higher rate-limits, whereas user tokens have lower rate-limits and broader permissions that are not required for searching and collecting tweets.
To retrieve a bearer token, both the `consumer key` and `consumer secret` for a Developer `Standard Project` or `Academic Research Project` app (that has been approved to use the Twitter API v2 endpoints) are required. These can be found or created on the Twitter Developer Portals [Projects & Apps](https://developer.twitter.com/en/portal/projects-and-apps) page. If you already have your bearer token you can also assign it directly to a `voson.tcn` token object using the `bearer` string parameter.
### Search Endpoint
By default the `recent` search endpoint is used that makes available for collection only tweets that were made within the last ~7 days. If the user has an `Academic Research Project` they can also use the `tcn_threads` parameter `endpoint = "all"` to collect on `full-archive` conversation tweets.
If collecting on historical tweets a `start_time = "2021-03-18T00:00:00Z"` datetime parameter will need to be specified if the conversation is older than 30 days old (the default API search start time). The datetime is in UTC and ISO 8601 format passed as a string.
### Rate-limits
The API `recent search` endpoint where the conversation tweets are retrieved from has a rate-limit of 450 requests per 15 min (per app). A single request can retrieve 100 tweets, translating to an upper limit of 45,000 tweets per 15 mins.
The `full-archive search` allows 300 requests of 500 tweets, translating to 150,000 tweets per 15 mins. There is also a limit of only 1 request per second for the `full-archive search` endpoint.
The `tweet lookup` endpoint used by `tcn_tweets` has a rate-limit of 300 requests of 100 tweets (30,000) per 15 minutes.
The `tcn_threads` function has a parameter `retry_on_limit` that when set to `TRUE` will wait until the API reset time before continuing when a rate-limit has been reached.
### Tweet Caps
There is currently a cap of 500 thousand tweets that be collected per month per project under the Twitter API v2 `Standard` product track, and 10 million for the `Academic Research` track. These caps only apply to certain API endpoints, such as `recent` and `full-archive search`. The `voson.tcn` `tcn_threads` function uses the search endpoints and therefore contributes towards this cap, however the `tcn_tweets` and `tcn_counts` functions do not.
Project caps are only able to be checked from the [Twitter Developer Console Dashboard](https://developer.twitter.com/en/portal/dashboard).
### Limitations
- Does not yet support OAuth1a authentication as there is no current use case.
- Does not currently collect additional user metadata for authors of tweets that were quoted and are external to the conversation. This can result in incomplete actor node metadata for some quoted tweets:
`user_A --replies--> user_B --quotes--> (external user_NA)`
- Handles but does not report on broken reply chains caused by deleted tweets or suspended users. These can result in a disconnected graph with additional components.
## Usage
### Get Access Token
Retrieve and save an app bearer token using its consumer keys.
```R
library(voson.tcn)
token <- tcn_token(consumer_key = "xxxxxxxx",
consumer_secret = "xxxxxxxx")
# alternatively a bearer token string can be assigned directly
token <- tcn_token(bearer = "xxxxxxxx")
# if you save the token to file this step only needs to be done once
saveRDS(token, "~/.tcn_token")
```
### Collect Conversation Tweets
Using tweet urls collect conversation tweets and metadata to generate networks.
```R
# read token from file
token <- readRDS("~/.tcn_token")
# choose a twitter conversation thread or multiple threads to collect
# e.g https://twitter.com/Warcraft/status/1372615159311699970, and
# https://twitter.com/Warcraft/status/1372487989385965569
# can use any tweet or tweet id that is part of the conversation thread
# input is a list of tweet ids, tweet urls or combination of both
tweet_ids <- c("https://twitter.com/Warcraft/status/1372615159311699970",
"1372487989385965569")
# collect the conversation thread tweets for supplied ids
thread_tweets <- tcn_threads(tweet_ids, token)
# academic track historical endpoint - specify start_time and optionally end_time
thread_tweets <- tcn_threads(tweet_ids, token = token,
endpoint = "all",
start_time = "2021-03-17T00:00:00Z")
```
The `tcn_threads` function produces a named list comprising a dataframe with tweets and metadata and a dataframe of users metadata.
*Note: If using the standard product track only recent search API requests can be performed. No tweets older than ~7 days will be collected in the conversation search. The tweets and any directly referenced tweets for the tweet id's provided will still be collected however.*
*Note: When specifying start and end times note that the API returns tweet created dates in `2021-03-17T00:00:00.000Z` format, however API requests require the shorter `2021-03-17T00:00:00Z` format.*
```r
names(thread_tweets)
# [1] "tweets" "users" "errors" "meta"
nrow(thread_tweets$tweets)
# [1] 147
nrow(thread_tweets$users)
# [1] 118
nrow(tweets$errors)
# [1] 0
nrow(thread_tweets$meta)
# [1] 2
```
### Collect Conversation Tweet Counts
This function can be used to retrieve the tweet activity in terms of tweet count for conversation id's. It will return the volume of tweets for conversations over time, optionally by specified granularity (day, hour or minute). This can be useful for determining how many tweets will be returned before collecting tweets for a conversation or getting an overview of conversation tweet activity.
The default time granularity is tweet counts per hour for the last ~7 days using the `recent` counts API endpoint. Researchers on the `Academic` track can specify an endpoint of `all` and access `full-archive` tweet counts.
Tweet counts do not contribute towards your Twitter projects monthly tweet cap.
```R
# get tweet count for conversation thread over approximately 3 days
# start time set approximately when conversation started
thread_counts <-
tcn_counts(
ids = "1491430617111674882",
token = token,
endpoint = "recent",
start_time = "2022-02-09T15:00:00Z",
end_time = "2022-02-12T10:00:00Z",
granularity = "day"
)
names(thread_counts)
# [1] "data" "errors" "meta" "counts"
print(thread_counts$counts)
# # A tibble: 4 x 6
# end start tweet_count timestamp conversation_id page
#
# 1 2022-02-10T00:00:00.000Z 2022-02-~ 3 1.64e9 14914306171116~ NA
# 2 2022-02-11T00:00:00.000Z 2022-02-~ 87 1.64e9 14914306171116~ NA
# 3 2022-02-12T00:00:00.000Z 2022-02-~ 29 1.64e9 14914306171116~ NA
# 4 2022-02-12T10:00:00.000Z 2022-02-~ 0 1.64e9 14914306171116~ NA
# get total tweets per conversation id for specified period
library(dplyr)
thread_counts$counts |> dplyr::count(conversation_id, wt = tweet_count)
# # A tibble: 1 x 2
# conversation_id n
#
# 1 1491430617111674882 119
```
### Collect Specific Tweets
Using tweet urls or id's it's also possible collect specific tweets and their metadata.
```R
# choose tweets to collect
# e.g https://twitter.com/Warcraft/status/1372615159311699970, and
# https://twitter.com/Warcraft/status/1372487989385965569
tweet_ids <- c("https://twitter.com/Warcraft/status/1372615159311699970",
"1372487989385965569")
# collect the tweets for supplied ids
tweets <- tcn_tweets(tweet_ids, token, referenced_tweets = FALSE)
names(tweets)
# [1] "tweets" "users" "errors"
nrow(tweets$tweets)
# [1] 2
nrow(tweets$users)
# [1] 1
nrow(tweets$errors)
# [1] 0
```
Tweets from any time can be collected using any product track access token and do not contribute to your Twitter projects monthly tweet cap.
### Generate Networks
Two types of networks can be generated from the tweets collected. An `activity` network in which tweets are the nodes and an `actor` network where Twitter users are the nodes. Edges are the relationships between nodes, in both networks these are either a `reply` or a `quote`, signifying for example that a tweet is a reply-to another tweet or that a user has replied to another user.
#### Create an activity network
The activity network has tweet metadata such as tweet metrics and author usernames as node attributes.
```R
activity_net <- tcn_network(thread_tweets, "activity")
# activity nodes dataframe structure
print(activity_net$nodes, n = 3)
# # A tibble: 148 x 11
# tweet_id user_id source created_at text public_metrics.~ public_metrics.~
#
# 1 13726476~ 9427940~ Twitt~ 2021-03-1~ @Warcr~ 0 0
# 2 13726461~ 1609030~ Twitt~ 2021-03-1~ @Patri~ 0 0
# 3 13726452~ 1190870~ Twitt~ 2021-03-1~ @Warcr~ 0 0
# # ... with 145 more rows, and 4 more variables:
# # public_metrics.like_count , public_metrics.quote_count ,
# # profile.name , profile.username
# activity edges dataframe structure
print(activity_net$edges, n = 3)
# # A tibble: 122 x 3
# from to type
#
# 1 1372636834971455494 1372630068162297860 replied_to
# 2 1372635200748937223 1372615159311699970 replied_to
# 3 1372634777275265029 1372615159311699970 replied_to
# # ... with 119 more rows
```
#### Create an actor network
The actor network has additional user profile metadata as node attributes.
```R
actor_net <- tcn_network(thread_tweets, "actor")
# actor nodes dataframe structure
print(actor_net$nodes, n = 3)
# # A tibble: 105 x 13
# user_id source profile.name profile.profile~ profile.location profile.username
#
# 1 275993~ Twitt~ "\U0001d43f~ https://pbs.twi~ England Stab~
# 2 133101~ Twitt~ "Andr ~ https://pbs.twi~ NA virg~
# 3 240160~ Twitt~ "Sebast ~ https://pbs.twi~ NA Nord~
# # ... with 102 more rows, and 7 more variables: profile.created_at ,
# # profile.description , profile.verified ,
# # profile.public_metrics.followers_count ,
# # profile.public_metrics.following_count ,
# # profile.public_metrics.tweet_count ,
# # profile.public_metrics.listed_count
# actor edges dataframe structure
print(actor_net$edges, n = 3)
# # A tibble: 124 x 6
# from to type tweet_id created_at text
#
# 1 2759935913 24599~ reply 1372636834~ 2021-03-18T19~ "@Limp ~ @Warcraft @MSF_~
# 2 133101119~ 61033~ reply 1372635200~ 2021-03-18T19~ "@Warcraft @MSF_USA Coming~
# 3 2401609580 61033~ reply 1372634777~ 2021-03-18T19~ "@Warcraft @MSF_USA When d~
# # ... with 121 more rows
```
### Network Graphs
Networks can be converted into different formats and plotted using graph packages such as `igraph` and `ggraph`. Below is an example for plotting a threads actor network.
```R
library(ggraph)
library(igraph)
# create igraph
g <- graph_from_data_frame(
actor_net$edges,
vertices = actor_net$nodes
)
# dashed lines for quote edges
line_vals <- c(reply = "solid", quote = "dashed")
# plot actor network
ggraph(g, layout = layout.auto(g)) +
geom_edge_loop(color = "gray") +
geom_edge_fan(
aes(linetype = as.factor(type)),
color = "gray",
arrow = arrow(length = unit(2, 'mm')),
start_cap = circle(1.5, 'mm'),
end_cap = circle(1.5, 'mm'),
strength = 1.2
) +
scale_linetype_manual(values = line_vals) +
geom_node_point(
size = 2.5,
aes(color = as.factor(name))
)
```
Plots of an activity network and corresponding actor reply network graph generated from a small Twitter conversation thread.
## Code of Conduct
Please note that the VOSON Lab projects are released with a [Contributor Code of Conduct](https://contributor-covenant.org/version/2/0/CODE_OF_CONDUCT.html). By contributing to this project, you agree to abide by its terms.