README.md
1## twitteR
2twitteR is an R package which provides access to the Twitter API. Most functionality of the API is supported, with a bias towards API calls that are more useful in data analysis as opposed to daily interaction.
3
4## Getting Started
5
6- Please read the [user vignette](http://geoffjentry.hexdump.org/twitteR.pdf), which admittedly can get a bit out of date
7- Create a Twitter application at http://dev.twitter.com. Make sure to give the app read, write and direct message authority.
8- Take note of the following values from the Twitter app page: "API key", "API secret", "Access token", and "Access token secret".
9- You can use the CRAN version (stable) via the standard `install.packages("twitteR")` or use the github version. To do the latter:
10 - `install.packages(c("devtools", "rjson", "bit64", "httr"))`
11 - Make sure to restart your R session at this point
12 - `library(devtools)`
13 - `install_github("geoffjentry/twitteR")`
14- At this point you should have `twitteR` installed and can proceed:
15 - `library(twitteR)`
16 - `setup_twitter_oauth("API key", "API secret")`
17 - The `API key` and `API secret` are from the Twitter app page above. This will lead you through `httr`'s OAuth authentication process. I recommend you look at the man page for `Token` in `httr` for an explanation of how it handles caching.
18 - You should be ready to go!
19- If you have any questions or issues, check out the [mailing list](http://lists.hexdump.org/listinfo.cgi/twitter-users-hexdump.org)
20