This repository has been archived by the owner on Nov 10, 2024. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 200
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
3 changed files
with
100 additions
and
89 deletions.
There are no files selected for viewing
File renamed without changes.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,94 @@ | ||
|
|
||
| <!-- 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/workflows/R-CMD-check.yaml) | ||
| [](https://cran.r-project.org/package=rtweet) | ||
| [](https://app.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) | ||
| [](https://www.buymeacoffee.com/llrs) | ||
|
|
||
| <!-- badges: end --> | ||
|
|
||
| Use twitter from R. | ||
|
|
||
| **This package is no longer updated and no fixes can be expected.** | ||
| A request to Orphan the package on CRAN was sent! | ||
|
|
||
| The maintainer cannot longer check most of the output of the | ||
| functionality provided. If you want to volunteer reach out to the | ||
| maintainer. | ||
|
|
||
| ## Installation | ||
|
|
||
| To get the current released version from CRAN: | ||
|
|
||
| ``` r | ||
| install.packages("rtweet") | ||
| ``` | ||
|
|
||
| You can install the development version of rtweet from GitHub with: | ||
|
|
||
| ``` r | ||
| install.packages("rtweet", repos = 'https://ropensci.r-universe.dev') | ||
| ``` | ||
|
|
||
| ## Usage | ||
|
|
||
| All users must be authenticated to interact with Twitter’s APIs. 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). | ||
|
|
||
| ## Usage | ||
|
|
||
| Depending on if you are a paid user or not you can do more or less | ||
| things. | ||
|
|
||
| # Free | ||
|
|
||
| You can post (`tweet_post()`) and retrieve information about yourself | ||
| (`user_self()`). | ||
|
|
||
| # Paid | ||
|
|
||
| You can do all the other things: search tweets | ||
| (`tweet_search_recent()`), retrieve your own bookmarks | ||
| (`user_bookmarks()`), check who follows who, (`user_following()`, or | ||
| `user_followers()`), …. | ||
|
|
||
| ## Contact | ||
|
|
||
| Communicating with Twitter’s APIs relies on an internet connection, | ||
| which can sometimes be inconsistent. | ||
|
|
||
| If you have questions, or needs an example or want to share a [use | ||
| case](https://ropensci.org/usecases/), you can post them on [rOpenSci’s | ||
| discuss](https://discuss.ropensci.org/). Were you can [browse uses of | ||
| rtweet](https://discuss.ropensci.org/tags/c/usecases/10/rtweet) too. | ||
|
|
||
| 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. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,94 +1,11 @@ | ||
|
|
||
| <!-- README.md is generated from README.Rmd. Please edit that file --> | ||
| # rtweet | ||
|
|
||
| # rtweet <img src="man/figures/logo.png" width="160px" align="right" /> | ||
| # <package name> | ||
|
|
||
| <!-- badges: start --> | ||
| [](https://www.repostatus.org/#unsupported) | ||
| [](https://github.com/ropensci/software-review/issues/302) | ||
|
|
||
| [](https://github.com/ropensci/rtweet/actions/workflows/R-CMD-check.yaml) | ||
| [](https://cran.r-project.org/package=rtweet) | ||
| [](https://app.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) | ||
| [](https://www.buymeacoffee.com/llrs) | ||
| This package has been archived, you can request for it to be unarchived if you opt to resume maintenance, for that please contact rOpenSci. | ||
|
|
||
| <!-- badges: end --> | ||
|
|
||
| Use twitter from R. | ||
|
|
||
| **This package is no longer updated and no fixes can be expected.** | ||
| A request to Orphan the package on CRAN was sent! | ||
|
|
||
| The maintainer cannot longer check most of the output of the | ||
| functionality provided. If you want to volunteer reach out to the | ||
| maintainer. | ||
|
|
||
| ## Installation | ||
|
|
||
| To get the current released version from CRAN: | ||
|
|
||
| ``` r | ||
| install.packages("rtweet") | ||
| ``` | ||
|
|
||
| You can install the development version of rtweet from GitHub with: | ||
|
|
||
| ``` r | ||
| install.packages("rtweet", repos = 'https://ropensci.r-universe.dev') | ||
| ``` | ||
|
|
||
| ## Usage | ||
|
|
||
| All users must be authenticated to interact with Twitter’s APIs. 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). | ||
|
|
||
| ## Usage | ||
|
|
||
| Depending on if you are a paid user or not you can do more or less | ||
| things. | ||
|
|
||
| # Free | ||
|
|
||
| You can post (`tweet_post()`) and retrieve information about yourself | ||
| (`user_self()`). | ||
|
|
||
| # Paid | ||
|
|
||
| You can do all the other things: search tweets | ||
| (`tweet_search_recent()`), retrieve your own bookmarks | ||
| (`user_bookmarks()`), check who follows who, (`user_following()`, or | ||
| `user_followers()`), …. | ||
|
|
||
| ## Contact | ||
|
|
||
| Communicating with Twitter’s APIs relies on an internet connection, | ||
| which can sometimes be inconsistent. | ||
|
|
||
| If you have questions, or needs an example or want to share a [use | ||
| case](https://ropensci.org/usecases/), you can post them on [rOpenSci’s | ||
| discuss](https://discuss.ropensci.org/). Were you can [browse uses of | ||
| rtweet](https://discuss.ropensci.org/tags/c/usecases/10/rtweet) too. | ||
|
|
||
| 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. | ||
| The former README is now in [README-old](https://github.com/ropensci-archive/rtweet/blob/master/README-old.md). |