rtweet v0.6.0

0

Monthly downloads

0th

Percentile

Collecting Twitter Data

An implementation of calls designed to collect and organize Twitter data via Twitter's REST and stream Application Program Interfaces (API), which can be found at the following URL: <https://developer.twitter.com/en/docs>.

Readme

rtweet

Build Status CRAN\_Status\_Badge Downloads Downloads Rdoc

R client for accessing Twitter's REST and stream APIs.

Check out the rtweet package documentation website.

Install

To get the current released version from CRAN:

## install rtweet from CRAN
install.packages("rtweet")

## load rtweet package
library(rtweet)

To get the current development version from Github:

## install devtools package if it's not already
if (!requireNamespace("devtools", quietly = TRUE)) {
  install.packages("devtools")
}

## install dev version of rtweet from github
devtools::install_github("mkearney/rtweet")

## load rtweet package
library(rtweet)

Getting started

NEW: All you need is a Twitter account and rtweet and you're up and running!

API authorization

  • The first time you make an API request---e.g., search_tweets(), stream_tweets(), get_followers()---a browser window will open.
  • Log in to your Twitter account.
  • Agree/authorize the rtweet application.

And that's it! You're ready to start collecting and analyzing Twitter data!

Package features

Search tweets

Search for up to 18,000 (non-retweeted) tweets containing the rstats hashtag.

## search for 5000 tweets using the rstats hashtag
rt <- search_tweets(
  "#rstats", n = 18000, include_rts = FALSE
)

Quickly visualize frequency of tweets over time using ts_plot().

## plot time series of tweets
ts_plot(rt, "3 hours") +
  ggplot2::theme_minimal() +
  ggplot2::theme(plot.title = ggplot2::element_text(face = "bold")) +
  ggplot2::labs(
    x = NULL, y = NULL,
    title = "Frequency of #rstats Twitter statuses from past 9 days",
    subtitle = "Twitter status (tweet) counts aggregated using three-hour intervals",
    caption = "\nSource: Data collected from Twitter's REST API via rtweet"
  )

Twitter rate limits cap the number of search results returned to 18,000 every 15 minutes. To request more than that, simply set retryonratelimit = TRUE and rtweet will wait for rate limit resets for you.

## search for 250,000 tweets containing the word data
rt <- search_tweets(
  "data", n = 250000, retryonratelimit = TRUE
)

Search by geo-location---for example, find 10,000 tweets in the English language sent from the United States.

## search for 10,000 tweets sent from the US
rt <- search_tweets(
  "lang:en", geocode = lookup_coords("usa"), n = 10000
)

## create lat/lng variables using all available tweet and profile geo-location data
rt <- lat_lng(rt)

## plot state boundaries
par(mar = c(0, 0, 0, 0))
maps::map("state", lwd = .25)

## plot lat and lng points onto state map
with(rt, points(lng, lat, pch = 20, cex = .75, col = rgb(0, .3, .7, .75)))

Stream tweets

Randomly sample (approximately 1%) from the live stream of all tweets.

## random sample for 30 seconds (default)
rt <- stream_tweets("")

Stream all geo enabled tweets from London for 60 seconds.

## stream tweets from london for 60 seconds
rt <- stream_tweets(lookup_coords("london, uk"), timeout = 60)

Stream all tweets mentioning realDonaldTrump or Trump for a week.

## stream london tweets for a week (60 secs x 60 mins * 24 hours *  7 days)
stream_tweets(
  "realdonaldtrump,trump",
  timeout = 60 * 60 * 24 * 7,
  file_name = "tweetsabouttrump.json",
  parse = FALSE
)

## read in the data as a tidy tbl data frame
djt <- parse_stream("tweetsabouttrump.json")

Get friends

Retrieve a list of all the accounts a user follows.

## get user IDs of accounts followed by CNN
cnn_fds <- get_friends("cnn")

## lookup data on those accounts
cnn_fds_data <- lookup_users(cnn_fds$user_id)

Get followers

Retrieve a list of the accounts following a user.

## get user IDs of accounts following CNN
cnn_flw <- get_followers("cnn", n = 75000)

## lookup data on those accounts
cnn_flw_data <- lookup_users(cnn_flw$user_id)

Or if you really want ALL of their followers:

## how many total follows does cnn have?
cnn <- lookup_users("cnn")

## get them all (this would take a little over 5 days)
cnn_flw <- get_followers(
  "cnn", n = cnn$followers_count, retryonratelimit = TRUE
)

Get timelines

Get the most recent 3,200 tweets from cnn, BBCWorld, and foxnews.

## get user IDs of accounts followed by CNN
tmls <- get_timelines(c("cnn", "BBCWorld", "foxnews"), n = 3200)

## plot the frequency of tweets for each user over time
tmls %>%
  dplyr::filter(created_at > "2017-10-29") %>%
  dplyr::group_by(screen_name) %>%
  ts_plot("days", trim = 1L) +
  ggplot2::geom_point() +
  ggplot2::theme_minimal() +
  ggplot2::theme(
    legend.title = ggplot2::element_blank(),
    legend.position = "bottom",
    plot.title = ggplot2::element_text(face = "bold")) +
  ggplot2::labs(
    x = NULL, y = NULL,
    title = "Frequency of Twitter statuses posted by news organization",
    subtitle = "Twitter status (tweet) counts aggregated by day from October/November 2017",
    caption = "\nSource: Data collected from Twitter's REST API via rtweet"
  )

Get favorites

Get the 3,000 most recently favorited statuses by JK Rowling.

jkr <- get_favorites("jk_rowling", n = 3000)

Search users

Search for 1,000 users with the rstats hashtag in their profile bios.

## search for users with #rstats in their profiles
usrs <- search_users("#rstats", n = 1000)

Discover what's currently trending in San Francisco.

sf <- get_trends("san francisco")

For posting (tweeting from R console) or read DM permissions

  • If you'd like to post Twitter statuses, follow or unfollow accounts, and/or read your direct messages, you'll need to create your own Twitter app.
  • To create your own Twitter app, follow the instructions in the authorization vignette on obtaining and using access tokens.
## authorizing API access
vignette("auth", package = "rtweet")

Other vignettes

Quick overview of rtweet package

## quick overview of rtweet functions
vignette("intro", package = "rtweet")

Live streaming tweets data

## working with the stream
vignette("stream", package = "rtweet")

Contact

Communicating with Twitter's APIs relies on an internet connection, which can sometimes be inconsistent. With that said, if you encounter an obvious bug for which there is not already an active issue, please create a new issue with all code used (preferably a reproducible example) on Github.

Functions in rtweet

Name Description
get_friends Get user IDs of accounts followed by target user(s).
as_screenname Coerces user identifier(s) to be evaluated as a screen name(s).
emojis Emojis codes and descriptions data.
get_collections Get collections by user or status id.
direct_messages Get the most recent direct messages sent to the authenticating user.
get_followers Get user IDs for accounts following target user.
get_mentions Get mentions for the authenticating user.
lat_lng Adds single-point latitude and longitude variables to tweets data.
do_call_rbind Binds list of data frames while preserving attribute (tweets or users) data.
lists_members Get the members of a specified Twitter list.
create_token Creating Twitter authorization token(s).
get_timeline Get one or more user timelines (tweets posted by target user(s)).
get_retweeters Get user IDs of users who retweeted a given status.
get_retweets Get the most recent retweets of a specific Twitter status
get_tokens Fetching Twitter authorization token(s).
lists_statuses Get a timeline of tweets authored by members of a specified list.
lists_users Get all lists a specified user subscribes to, including their own.
lists_subscribers Get subscribers of a specified list.
lookup_collections Get collections by user or status id.
lookup_coords Get coordinates of specified location.
post_friendship Updates friendship notifications and retweet abilities.
lookup_friendships Lookup friendship information between two specified users.
parse_stream Converts Twitter stream data (JSON file) into parsed data frame.
post_message Posts direct message from user's Twitter account
plain_tweets Clean up character vector (tweets) to more of a plain text.
ts_data Converts tweets data into time series-like data object.
post_tweet Posts status update to user's Twitter account
ts_plot Plots tweets data as a time series-like data object.
rate_limit Get rate limit data for given Twitter access tokens.
read_twitter_csv Read comma separated value Twitter data.
stopwordslangs Twitter stop words in multiple languages data.
reexports Objects exported from other packages
stream_tweets Collect a live stream of Twitter data.
suggested_slugs Get user [account] suggestions for authenticating user
users_data Extracts users data from tweets data object.
get_trends Get Twitter trends data.
langs Language codes recognized by Twitter data.
write_as_csv Saves as flattened CSV file of Twitter data.
my_friendships Lookup friendship information between users.
lookup_statuses Get tweets data for given statuses (status IDs).
trends_available Available Twitter trends along with associated WOEID.
lookup_users Get Twitter users data for given users (user IDs or screen names).
tweets_data Extracts tweets data from users data object.
tweets_with_users Parsing data into tweets/users data tibbles
rtweet-package rtweet: Collecting Twitter data
search_users Get users data on accounts identified via search query.
save_as_csv Save Twitter data as a comma separated value file.
search_tweets Get tweets data on statuses identified via search query.
next_cursor next_cursor/max_id
post_favorite Favorites target status id.
post_follow Follows target twitter user.
get_favorites Get tweets data for statuses favorited by one or more target users.
No Results!

Vignettes of rtweet

Name
files/created.png
files/creating.png
files/keys.png
files/stream-filter.png
files/stream-ts.png
auth.Rmd
intro.Rmd
stream.Rmd
No Results!

Last month downloads

Details

Type Package
Date 2017-11-14
License MIT + file LICENSE
URL https://CRAN.R-project.org/package=rtweet
BugReports https://github.com/mkearney/rtweet/issues
Encoding UTF-8
VignetteBuilder knitr
LazyData yes
RoxygenNote 6.0.1
NeedsCompilation no
Packaged 2017-11-16 14:48:21 UTC; mwk
Repository CRAN
Date/Publication 2017-11-16 16:20:31 UTC

Include our badge in your README

[![Rdoc](http://www.rdocumentation.org/badges/version/rtweet)](http://www.rdocumentation.org/packages/rtweet)