<!DOCTYPE html>
<!-- Generated by pkgdown: do not edit by hand --><html lang="en"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><meta charset="utf-8"><meta http-equiv="X-UA-Compatible" content="IE=edge"><meta name="viewport" content="width=device-width, initial-scale=1.0"><title>Collect tweet data from twitter search — Collect.search.twitter • vosonSML</title><!-- favicons --><link rel="icon" type="image/png" sizes="16x16" href="../favicon-16x16.png"><link rel="icon" type="image/png" sizes="32x32" href="../favicon-32x32.png"><link rel="apple-touch-icon" type="image/png" sizes="180x180" href="../apple-touch-icon.png"><link rel="apple-touch-icon" type="image/png" sizes="120x120" href="../apple-touch-icon-120x120.png"><link rel="apple-touch-icon" type="image/png" sizes="76x76" href="../apple-touch-icon-76x76.png"><link rel="apple-touch-icon" type="image/png" sizes="60x60" href="../apple-touch-icon-60x60.png"><!-- jquery --><script src="https://cdnjs.cloudflare.com/ajax/libs/jquery/3.7.1/jquery.min.js" integrity="sha512-v2CJ7UaYy4JwqLDIrZUI/4hqeoQieOmAZNXBeQyjo21dadnwR+8ZaIJVT8EE2iyI61OV8e6M8PP2/4hpQINQ/g==" crossorigin="anonymous" referrerpolicy="no-referrer"></script><!-- Bootstrap --><link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/3.4.1/css/bootstrap.min.css" integrity="sha256-bZLfwXAP04zRMK2BjiO8iu9pf4FbLqX6zitd+tIvLhE=" crossorigin="anonymous"><script src="https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/3.4.1/js/bootstrap.min.js" integrity="sha256-nuL8/2cJ5NDSSwnKD8VqreErSWHtnEP9E7AySL+1ev4=" crossorigin="anonymous"></script><!-- bootstrap-toc --><link rel="stylesheet" href="../bootstrap-toc.css"><script src="../bootstrap-toc.js"></script><!-- Font Awesome icons --><link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.12.1/css/all.min.css" integrity="sha256-mmgLkCYLUQbXn0B1SRqzHar6dCnv9oZFPEC1g1cwlkk=" crossorigin="anonymous"><link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.12.1/css/v4-shims.min.css" integrity="sha256-wZjR52fzng1pJHwx4aV2AO3yyTOXrcDW7jBpJtTwVxw=" crossorigin="anonymous"><!-- clipboard.js --><script src="https://cdnjs.cloudflare.com/ajax/libs/clipboard.js/2.0.6/clipboard.min.js" integrity="sha256-inc5kl9MA1hkeYUt+EC3BhlIgyp/2jDIyBLS6k3UxPI=" crossorigin="anonymous"></script><!-- headroom.js --><script src="https://cdnjs.cloudflare.com/ajax/libs/headroom/0.11.0/headroom.min.js" integrity="sha256-AsUX4SJE1+yuDu5+mAVzJbuYNPHj/WroHuZ8Ir/CkE0=" crossorigin="anonymous"></script><script src="https://cdnjs.cloudflare.com/ajax/libs/headroom/0.11.0/jQuery.headroom.min.js" integrity="sha256-ZX/yNShbjqsohH1k95liqY9Gd8uOiE1S4vZc+9KQ1K4=" crossorigin="anonymous"></script><!-- pkgdown --><link href="../pkgdown.css" rel="stylesheet"><script src="../pkgdown.js"></script><link href="../extra.css" rel="stylesheet"><meta property="og:title" content="Collect tweet data from twitter search — Collect.search.twitter"><meta property="og:description" content="This function collects tweet data based on search terms and structures the data into a dataframe with
the class names &quot;datasource&quot; and &quot;twitter&quot;.
The twitter Standard search API sets a rate limit of 180 requests every 15 minutes. A maximum of 100 tweets can be
collected per search request meaning the maximum number of tweets per operation is 18000 / 15 minutes. More tweets
can be collected by using retryOnRateLimit = TRUE parameter which will cause the collection to pause if the
rate limit is reached and resume when the rate limit resets (in approximately 15 minutes). Alternatively the
twitter API parameter since_id can be used in a later session to resume a twitter search collection from the
last tweet previously collected as tweet status id's are sequential. The Standard API only returns tweets for the
last 7 days.
All of the search query operators available through the twitter API can be used in the searchTerm field. For
example, to search for tweets containing the term &quot;love&quot; or &quot;hate&quot; the &quot;OR&quot; operator can be
used in the term field: searchTerm = &quot;love OR hate&quot;. For more information refer to the twitter API
documentation for query operators:
https://developer.twitter.com/en/docs/twitter-api/v1/tweets/search/guides/standard-operators."><!-- mathjax --><script src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/MathJax.js" integrity="sha256-nvJJv9wWKEm88qvoQl9ekL2J+k/RWIsaSScxxlsrv8k=" crossorigin="anonymous"></script><script src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/config/TeX-AMS-MML_HTMLorMML.js" integrity="sha256-84DKXVJXs0/F8OTMzX4UR909+jtl4G7SPypPavF+GfA=" crossorigin="anonymous"></script><!--[if lt IE 9]>
<script src="https://oss.maxcdn.com/html5shiv/3.7.3/html5shiv.min.js"></script>
<script src="https://oss.maxcdn.com/respond/1.4.2/respond.min.js"></script>
<![endif]--></head><body data-spy="scroll" data-target="#toc">
    

    <div class="container template-reference-topic">
      <header><div class="navbar navbar-default navbar-fixed-top" role="navigation">
  <div class="container">
    <div class="navbar-header">
      <button type="button" class="navbar-toggle collapsed" data-toggle="collapse" data-target="#navbar" aria-expanded="false">
        <span class="sr-only">Toggle navigation</span>
        <span class="icon-bar"></span>
        <span class="icon-bar"></span>
        <span class="icon-bar"></span>
      </button>
      <span class="navbar-brand">
        <a class="navbar-link" href="../index.html">vosonSML</a>
        <span class="version label label-default" data-toggle="tooltip" data-placement="bottom" title="">0.34.3</span>
      </span>
    </div>

    <div id="navbar" class="navbar-collapse collapse">
      <ul class="nav navbar-nav"><li>
  <a href="../index.html">
    <span class="fa fa-home fa-lg"></span>
     
  </a>
</li>
<li>
  <a href="../news/index.html">
    <span class="fa fa-newspaper"></span>
     
    Changelog
  </a>
</li>
<li>
  <a href="../reference/index.html">
    <span class="fa fa-cubes fa-lg"></span>
     
    Reference
  </a>
</li>
<li class="dropdown">
  <a href="#" class="dropdown-toggle" data-toggle="dropdown" role="button" data-bs-toggle="dropdown" aria-expanded="false">
    <span class="fa fa-book"></span>
     
    Articles
     
    <span class="caret"></span>
  </a>
  <ul class="dropdown-menu" role="menu"><li>
      <a href="../articles/Intro-to-vosonSML.html">
        <span class="far fa-file-alt"></span>
         
        Introduction to vosonSML
      </a>
    </li>
    <li>
      <a href="https://vosonlab.github.io/posts/2021-03-15-hyperlink-networks-with-vosonsml" class="external-link">
        <span class="far fa-file-alt"></span>
         
        Hyperlink Networks with vosonSML
      </a>
    </li>
    <li>
      <a href="../articles/Twitter-Usage.html">
        <span class="far fa-file-alt"></span>
         
        Twitter Usage
      </a>
    </li>
    <li>
      <a href="https://vosonlab.github.io/posts/2022-06-05-egocentric-networks-from-twitter-timelines" class="external-link">
        <span class="far fa-file-alt"></span>
         
        Egocentric Networks from Twitter timelines
      </a>
    </li>
    <li>
      <a href="https://vosonlab.github.io/posts/2021-10-01-testing-bot-status-of-twitter-users" class="external-link">
        <span class="far fa-file-alt"></span>
         
        Testing the bot status of users in Twitter networks collected via vosonSML
      </a>
    </li>
  </ul></li>
      </ul><ul class="nav navbar-nav navbar-right"><li>
  <a href="http://vosonlab.net/" class="external-link">
    <span class="fa fa-flask fa-lg"></span>
     
  </a>
</li>
<li>
  <a href="https://twitter.com/vosonlab" class="external-link">
    <span class="fab fa-twitter-square fa-lg"></span>
     
  </a>
</li>
<li>
  <a href="https://github.com/vosonlab/vosonSML" class="external-link">
    <span class="fab fa-github fa-lg"></span>
     
  </a>
</li>
      </ul></div><!--/.nav-collapse -->
  </div><!--/.container -->
</div><!--/.navbar -->

      

      </header><div class="row">
  <div class="col-md-9 contents">
    <div class="page-header">
    <h1>Collect tweet data from twitter search</h1>
    <small class="dont-index">Source: <a href="https://github.com/vosonlab/vosonSML/blob/HEAD/R/Collect.search.twitter.R" class="external-link"><code>R/Collect.search.twitter.R</code></a></small>
    <div class="hidden name"><code>Collect.search.twitter.Rd</code></div>
    </div>

    <div class="ref-description">
    <p>This function collects tweet data based on search terms and structures the data into a dataframe with
the class names <code>"datasource"</code> and <code>"twitter"</code>.</p>
<p>The twitter Standard search API sets a rate limit of 180 requests every 15 minutes. A maximum of 100 tweets can be
collected per search request meaning the maximum number of tweets per operation is 18000 / 15 minutes. More tweets
can be collected by using <code>retryOnRateLimit = TRUE</code> parameter which will cause the collection to pause if the
rate limit is reached and resume when the rate limit resets (in approximately 15 minutes). Alternatively the
twitter API parameter <code>since_id</code> can be used in a later session to resume a twitter search collection from the
last tweet previously collected as tweet status id's are sequential. The Standard API only returns tweets for the
last 7 days.</p>
<p>All of the search query operators available through the twitter API can be used in the <code>searchTerm</code> field. For
example, to search for tweets containing the term <code>"love"</code> or <code>"hate"</code> the <code>"OR"</code> operator can be
used in the term field: <code>searchTerm = "love OR hate"</code>. For more information refer to the twitter API
documentation for query operators:
<a href="https://developer.twitter.com/en/docs/twitter-api/v1/tweets/search/guides/standard-operators" class="external-link">https://developer.twitter.com/en/docs/twitter-api/v1/tweets/search/guides/standard-operators</a>.</p>
    </div>

    <div id="ref-usage">
    <div class="sourceCode"><pre class="sourceCode r"><code><span><span class="co"># S3 method for search.twitter</span></span>
<span><span class="fu"><a href="Collect.html">Collect</a></span><span class="op">(</span></span>
<span>  <span class="va">credential</span>,</span>
<span>  <span class="va">endpoint</span>,</span>
<span>  searchTerm <span class="op">=</span> <span class="st">""</span>,</span>
<span>  searchType <span class="op">=</span> <span class="st">"recent"</span>,</span>
<span>  numTweets <span class="op">=</span> <span class="fl">100</span>,</span>
<span>  includeRetweets <span class="op">=</span> <span class="cn">TRUE</span>,</span>
<span>  retryOnRateLimit <span class="op">=</span> <span class="cn">TRUE</span>,</span>
<span>  writeToFile <span class="op">=</span> <span class="cn">FALSE</span>,</span>
<span>  verbose <span class="op">=</span> <span class="cn">FALSE</span>,</span>
<span>  <span class="va">...</span></span>
<span><span class="op">)</span></span></code></pre></div>
    </div>

    <div id="arguments">
    <h2>Arguments</h2>
    <dl><dt>credential</dt>
<dd><p>A <code>credential</code> object generated from <code>Authenticate</code> with class name <code>"twitter"</code>.</p></dd>


<dt>endpoint</dt>
<dd><p>API endpoint.</p></dd>


<dt>searchTerm</dt>
<dd><p>Character string. Specifies a twitter search term. For example, <code>"Australian politics"</code> or the
hashtag <code>"#auspol"</code>.</p></dd>


<dt>searchType</dt>
<dd><p>Character string. Returns filtered tweets as per search type <code>recent</code>, <code>mixed</code> or
<code>popular</code>. Default type is <code>recent</code>.</p></dd>


<dt>numTweets</dt>
<dd><p>Numeric. Specifies how many tweets to be collected. Defaults is <code>100</code>.</p></dd>


<dt>includeRetweets</dt>
<dd><p>Logical. Specifies if the search should filter out retweets. Defaults is <code>TRUE</code>.</p></dd>


<dt>retryOnRateLimit</dt>
<dd><p>Logical. When the API rate-limit is reached should the collection wait and resume when it resets. Default is <code>TRUE</code>.</p></dd>


<dt>writeToFile</dt>
<dd><p>Logical. Write collected data to file. Default is <code>FALSE</code>.</p></dd>


<dt>verbose</dt>
<dd><p>Logical. Output additional information. Default is <code>FALSE</code>.</p></dd>


<dt>...</dt>
<dd><p>Arguments passed on to <code><a href="https://docs.ropensci.org/rtweet/reference/search_tweets.html" class="external-link">rtweet::search_tweets</a></code></p><dl><dt><code>geocode</code></dt>
<dd><p>Geographical limiter of the template
"latitude,longitude,radius" e.g., <code>geocode = "37.78,-122.40,1mi"</code>.</p></dd>

    <dt><code>since_id</code></dt>
<dd><p>Supply a vector of ids or a data frame of previous results to
find tweets <strong>newer</strong> than <code>since_id</code>.</p></dd>

    <dt><code>max_id</code></dt>
<dd><p>Supply a vector of ids or a data frame of previous results to
find tweets <strong>older</strong> than <code>max_id</code>.</p></dd>

    <dt><code>parse</code></dt>
<dd><p>If <code>TRUE</code>, the default, returns a tidy data frame. Use <code>FALSE</code>
to return the "raw" list corresponding to the JSON returned from the
Twitter API.</p></dd>

  
</dl></dd>

</dl></div>
    <div id="value">
    <h2>Value</h2>
    

<p>A tibble object with class names <code>"datasource"</code> and <code>"twitter"</code>.</p>
    </div>
    <div id="note">
    <h2>Note</h2>
    <p>Additional parameters passed to this function in the ellipsis <code>...</code> will also be passed to the Twitter
search API request. Most parameters have been covered but a complete list can be found here:
<a href="https://developer.twitter.com/en/docs/twitter-api/v1/tweets/search/api-reference/get-search-tweets" class="external-link">https://developer.twitter.com/en/docs/twitter-api/v1/tweets/search/api-reference/get-search-tweets</a> A useful
additional parameter is <code>language</code> allowing the user can restrict tweets returned to a particular language
using an ISO 639-1 code. For example, to restrict a search to tweets in English the value <code>language = "en"</code>
can be passed to this function.</p>
    </div>

    <div id="ref-examples">
    <h2>Examples</h2>
    <div class="sourceCode"><pre class="sourceCode r"><code><span class="r-in"><span><span class="kw">if</span> <span class="op">(</span><span class="cn">FALSE</span><span class="op">)</span> <span class="op">{</span></span></span>
<span class="r-in"><span><span class="co"># search and collect 100 recent tweets for the hashtag #auspol</span></span></span>
<span class="r-in"><span><span class="va">myTwitterData</span> <span class="op">&lt;-</span> <span class="va">twitterAuth</span> <span class="op">|&gt;</span></span></span>
<span class="r-in"><span>  <span class="fu"><a href="Collect.html">Collect</a></span><span class="op">(</span>searchTerm <span class="op">=</span> <span class="st">"#auspol"</span>, searchType <span class="op">=</span> <span class="st">"recent"</span>, numTweets <span class="op">=</span> <span class="fl">100</span>, verbose <span class="op">=</span> <span class="cn">TRUE</span>,</span></span>
<span class="r-in"><span>          includeRetweets <span class="op">=</span> <span class="cn">FALSE</span>, retryOnRateLimit <span class="op">=</span> <span class="cn">TRUE</span>, writeToFile <span class="op">=</span> <span class="cn">TRUE</span><span class="op">)</span></span></span>
<span class="r-in"><span><span class="op">}</span></span></span>
<span class="r-in"><span></span></span>
</code></pre></div>
    </div>
  </div>
  <div class="col-md-3 hidden-xs hidden-sm" id="pkgdown-sidebar">
    <nav id="toc" data-toggle="toc" class="sticky-top"><h2 data-toc-skip>Contents</h2>
    </nav></div>
</div>


      <footer><div class="copyright">
  <p></p><p>Developed by Bryan Gertzel, Robert Ackland, Timothy Graham.</p>
</div>

<div class="pkgdown">
  <p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.9.</p>
</div>

      </footer></div>

  


  

  </body></html>

