<!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, shrink-to-fit=no"><title>Collect reddit thread listings from subreddits — Collect.listing.reddit • 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"><script src="../lightswitch.js"></script><script src="../deps/jquery-3.6.0/jquery-3.6.0.min.js"></script><meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no"><link href="../deps/bootstrap-5.3.1/bootstrap.min.css" rel="stylesheet"><script src="../deps/bootstrap-5.3.1/bootstrap.bundle.min.js"></script><link href="../deps/font-awesome-6.4.2/css/all.min.css" rel="stylesheet"><link href="../deps/font-awesome-6.4.2/css/v4-shims.min.css" rel="stylesheet"><script src="../deps/headroom-0.11.0/headroom.min.js"></script><script src="../deps/headroom-0.11.0/jQuery.headroom.min.js"></script><script src="../deps/bootstrap-toc-1.0.1/bootstrap-toc.min.js"></script><script src="../deps/clipboard.js-2.0.11/clipboard.min.js"></script><script src="../deps/search-1.0.0/autocomplete.jquery.min.js"></script><script src="../deps/search-1.0.0/fuse.min.js"></script><script src="../deps/search-1.0.0/mark.min.js"></script><!-- pkgdown --><script src="../pkgdown.js"></script><link href="../extra.css" rel="stylesheet"><meta property="og:title" content="Collect reddit thread listings from subreddits — Collect.listing.reddit"><meta name="description" content="Collects thread listings for one or more specified subreddits and structures the data into a dataframe."><meta property="og:description" content="Collects thread listings for one or more specified subreddits and structures the data into a dataframe."><meta property="og:image" content="https://vosonlab.github.io/vosonSML/images/logo.png"><meta property="og:image:alt" content="vosonSML - Social Media Lab"><meta name="twitter:card" content="summary_large_image"><meta name="twitter:creator" content="@vosonlab"><meta name="twitter:site" content="@vosonlab"></head><body>
    <a href="#main" class="visually-hidden-focusable">Skip to contents</a>


    <nav class="navbar navbar-expand-lg fixed-top " aria-label="Site navigation"><div class="container">

    <a class="navbar-brand me-2" href="../index.html">vosonSML</a>

    <small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="">0.35.0</small>


    <button class="navbar-toggler" type="button" data-bs-toggle="collapse" data-bs-target="#navbar" aria-controls="navbar" aria-expanded="false" aria-label="Toggle navigation">
      <span class="navbar-toggler-icon"></span>
    </button>

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


  </div>
</nav><div class="container template-reference-topic">
<div class="row">
  <main id="main" class="col-md-9"><div class="page-header">

      <h1>Collect reddit thread listings from subreddits</h1>
      <small class="dont-index">Source: <a href="https://github.com/vosonlab/vosonSML/blob/HEAD/R/Collect.listing.reddit.R" class="external-link"><code>R/Collect.listing.reddit.R</code></a>, <a href="https://github.com/vosonlab/vosonSML/blob/HEAD/R/zzz.R" class="external-link"><code>R/zzz.R</code></a></small>
      <div class="d-none name"><code>Collect.listing.reddit.Rd</code></div>
    </div>

    <div class="ref-description section level2">
    <p>Collects thread listings for one or more specified subreddits and structures the data into a dataframe.</p>
    </div>

    <div class="section level2">
    <h2 id="ref-usage">Usage<a class="anchor" aria-label="anchor" href="#ref-usage"></a></h2>
    <div class="sourceCode"><pre class="sourceCode r"><code><span><span class="co"># S3 method for class 'listing.reddit'</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>  <span class="va">subreddits</span>,</span>
<span>  sort <span class="op">=</span> <span class="st">"hot"</span>,</span>
<span>  period <span class="op">=</span> <span class="st">"all"</span>,</span>
<span>  max <span class="op">=</span> <span class="fl">25</span>,</span>
<span>  waitTime <span class="op">=</span> <span class="fu"><a href="https://rdrr.io/r/base/c.html" class="external-link">c</a></span><span class="op">(</span><span class="fl">6</span>, <span class="fl">8</span><span class="op">)</span>,</span>
<span>  ua <span class="op">=</span> <span class="fu"><a href="https://rdrr.io/r/base/options.html" class="external-link">getOption</a></span><span class="op">(</span><span class="st">"HTTPUserAgent"</span><span class="op">)</span>,</span>
<span>  <span class="va">...</span>,</span>
<span>  writeToFile <span class="op">=</span> <span class="cn">FALSE</span>,</span>
<span>  verbose <span class="op">=</span> <span class="cn">TRUE</span></span>
<span><span class="op">)</span></span>
<span></span>
<span><span class="fu">collect_reddit_listings</span><span class="op">(</span></span>
<span>  <span class="va">subreddits</span>,</span>
<span>  sort <span class="op">=</span> <span class="st">"new"</span>,</span>
<span>  period <span class="op">=</span> <span class="cn">NULL</span>,</span>
<span>  max <span class="op">=</span> <span class="fl">25</span>,</span>
<span>  waitTime <span class="op">=</span> <span class="fu"><a href="https://rdrr.io/r/base/c.html" class="external-link">c</a></span><span class="op">(</span><span class="fl">6</span>, <span class="fl">8</span><span class="op">)</span>,</span>
<span>  ua <span class="op">=</span> <span class="fu">vsml_ua</span><span class="op">(</span><span class="op">)</span>,</span>
<span>  writeToFile <span class="op">=</span> <span class="cn">FALSE</span>,</span>
<span>  verbose <span class="op">=</span> <span class="cn">TRUE</span>,</span>
<span>  <span class="va">...</span></span>
<span><span class="op">)</span></span></code></pre></div>
    </div>

    <div class="section level2">
    <h2 id="arguments">Arguments<a class="anchor" aria-label="anchor" href="#arguments"></a></h2>


<dl><dt id="arg-credential">credential<a class="anchor" aria-label="anchor" href="#arg-credential"></a></dt>
<dd><p>A <code>credential</code> object generated from <code>Authenticate</code> with class name <code>"reddit"</code>.</p></dd>


<dt id="arg-endpoint">endpoint<a class="anchor" aria-label="anchor" href="#arg-endpoint"></a></dt>
<dd><p>API endpoint.</p></dd>


<dt id="arg-subreddits">subreddits<a class="anchor" aria-label="anchor" href="#arg-subreddits"></a></dt>
<dd><p>Character vector. Subreddit names to collect thread listings from.</p></dd>


<dt id="arg-sort">sort<a class="anchor" aria-label="anchor" href="#arg-sort"></a></dt>
<dd><p>Character vector. Listing thread sort order. Options are <code>"hot"</code>, <code>"top"</code>, <code>"new"</code>, and
<code>"rising"</code>. Default is <code>"hot"</code>.</p></dd>


<dt id="arg-period">period<a class="anchor" aria-label="anchor" href="#arg-period"></a></dt>
<dd><p>Character vector. Listing top threads by time period. Only applicable to sort order by <code>"top"</code>.
Options are <code>"hour"</code>, <code>"day"</code>, <code>"week"</code>, <code>"month"</code>, <code>"year"</code> and <code>"all"</code>. Default is
<code>"all"</code>.</p></dd>


<dt id="arg-max">max<a class="anchor" aria-label="anchor" href="#arg-max"></a></dt>
<dd><p>Numeric vector. Maximum number of threads in listing to return. Default is <code>25</code>.</p></dd>


<dt id="arg-waittime">waitTime<a class="anchor" aria-label="anchor" href="#arg-waittime"></a></dt>
<dd><p>Numeric vector. Time range in seconds to select random wait from in-between url collection requests.
Minimum is 3 seconds. Default is <code>c(6, 8)</code> for a wait time chosen from between 6 and 8 seconds.</p></dd>


<dt id="arg-ua">ua<a class="anchor" aria-label="anchor" href="#arg-ua"></a></dt>
<dd><p>Character string. Override User-Agent string to use in Reddit thread requests. Default is
<code>option("HTTPUserAgent")</code> value as set by vosonSML.</p></dd>


<dt id="arg--">...<a class="anchor" aria-label="anchor" href="#arg--"></a></dt>
<dd><p>Additional parameters passed to function. Not used in this method.</p></dd>


<dt id="arg-writetofile">writeToFile<a class="anchor" aria-label="anchor" href="#arg-writetofile"></a></dt>
<dd><p>Logical. Write collected data to file. Default is <code>FALSE</code>.</p></dd>


<dt id="arg-verbose">verbose<a class="anchor" aria-label="anchor" href="#arg-verbose"></a></dt>
<dd><p>Logical. Output additional information. Default is <code>TRUE</code>.</p></dd>

</dl></div>
    <div class="section level2">
    <h2 id="value">Value<a class="anchor" aria-label="anchor" href="#value"></a></h2>
    <p>A <code>tibble</code> object with class names <code>"listing"</code> and <code>"reddit"</code>.</p>
    </div>
    <div class="section level2">
    <h2 id="note">Note<a class="anchor" aria-label="anchor" href="#note"></a></h2>
    <p>The reddit endpoint used for collection has maximum limit of 25 per listing.</p>
    </div>

    <div class="section level2">
    <h2 id="ref-examples">Examples<a class="anchor" aria-label="anchor" href="#ref-examples"></a></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 class="co"># \dontrun{</span></span></span>
<span class="r-in"><span><span class="co"># subreddit url to collect threads from</span></span></span>
<span class="r-in"><span><span class="va">subreddits</span>  <span class="op">&lt;-</span> <span class="fu"><a href="https://rdrr.io/r/base/c.html" class="external-link">c</a></span><span class="op">(</span><span class="st">"datascience"</span><span class="op">)</span></span></span>
<span class="r-in"><span></span></span>
<span class="r-in"><span><span class="va">redditListing</span> <span class="op">&lt;-</span> <span class="va">redditAuth</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>endpoint <span class="op">=</span> <span class="st">"listing"</span>, subreddits <span class="op">=</span> <span class="va">subreddits</span>, sort <span class="op">=</span> <span class="st">"new"</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 class="co"># }</span></span></span>
<span class="r-in"><span></span></span>
</code></pre></div>
    </div>
  </main><aside class="col-md-3"><nav id="toc" aria-label="Table of contents"><h2>On this page</h2>
    </nav></aside></div>


    <footer><div class="pkgdown-footer-left">
  <p>Developed by <a href="https://vosonlab.net" class="external-link"><span>VOSON Lab</span></a>.</p>
</div>

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

    </footer></div>





  </body></html>

