forked from ropensci/rtweet
/
README.md
133 lines (93 loc) · 3.99 KB
/
README.md
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
<!-- README.md is generated from README.Rmd. Please edit that file -->
# rtweet <img src="man/figures/logo.png" width="160px" align="right" />
<!-- badges: start -->
[](https://github.com/ropensci/rtweet/actions)
[](https://cran.r-project.org/package=rtweet)
[](https://codecov.io/gh/ropensci/rtweet?branch=master)
[](https://zenodo.org/badge/latestdoi/64161359)
[](https://github.com/ropensci/software-review/issues/302)
[](https://doi.org/10.21105/joss.01829)
<!-- badges: end -->
Use twitter from R. Get started by reading `vignette("rtweet")`.
## Installation
To get the current released version from CRAN:
``` r
install.packages("rtweet")
```
## Usage
All users must be authenticated to interact with Twitter’s APIs. The
easiest way to authenticate is to use your personal twitter account -
this will happen automatically (via a browser popup) the first time you
use an rtweet function. See `auth_setup_default()` for details. Using
your personal account is fine for casual use, but if you are trying to
collect a lot of data it’s a good idea to authentication with your own
Twitter “app”. See `vignette("auth", package = "rtweet")` for details.
``` r
library(rtweet)
```
{{rtweet}} should be used in strict accordance with Twitter’s [developer
terms](https://developer.twitter.com/en/developer-terms/more-on-restricted-use-cases).
### Search tweets or users
Search for up to 10,000 tweets containing \#rstats, excluding retweets:
``` r
rt <- search_tweets("#rstats", n = 10000, include_rts = FALSE)
```
Twitter rate limits cap the number of search results returned to 18,000
every 15 minutes. To request more than that, set
`retryonratelimit = TRUE` and rtweet will wait for rate limit resets for
you.
Search for 1,000 users with the \#rstats in their profile:
``` r
usrs <- search_users("#rstats", n = 1000)
```
### Stream tweets
Randomly sample (approximately 1%) from the live stream of all tweets:
``` r
rt <- stream_tweets("")
```
Stream all geo-located tweets from London for 60 seconds:
``` r
rt <- stream_tweets(lookup_coords("london, uk"), timeout = 60)
```
### Get friends and followers
Get all accounts followed by a user:
``` r
## 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 all accounts following a user:
``` r
## get user IDs of accounts following CNN
cnn_flw <- get_followers("cnn", n = 10000)
cnn_flw_data <- lookup_users(cnn_flw$user_id)
```
If you want *all* followers, you’ll need you’ll need to set `n = Inf`
and `retryonratelimit = TRUE` but be warned that this might take a
*long* time.
### Get timelines
Get the most recent 3,200 tweets from CNN, BBC World, and Fox News:
``` r
## get user IDs of accounts followed by CNN
tmls <- get_timelines(c("cnn", "BBCWorld", "foxnews"), n = 3200)
```
### Get favorites
Get the 3,000 most recently favorited statuses by Justin Bieber:
``` r
jkr <- get_favorites("justinbieber", n = 3000)
```
## 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](https://github.com/ropensci/rtweet/issues), please [create a new
issue](https://github.com/ropensci/rtweet/issues/new) with all code used
(preferably a reproducible example) on Github.
# Code of Conduct
Please note that this package is released with a [Contributor Code of
Conduct](https://ropensci.org/code-of-conduct/). By contributing to this
project, you agree to abide by its terms.