<!-- Generated by pkgdown: do not edit by hand -->
<!DOCTYPE html>
<html lang="en">
  <head>
  <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>Enhances twitter actor network graph by adding user attributes to nodes — vosonSML::AddTwitterUserData • vosonSML</title>


<!-- jquery -->
<script src="https://cdnjs.cloudflare.com/ajax/libs/jquery/3.3.1/jquery.min.js" integrity="sha256-FgpCb/KJQlLNfOu91ta32o/NMZxltwRo8QtmkMRdAu8=" crossorigin="anonymous"></script>
<!-- Bootstrap -->

<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/3.3.7/css/bootstrap.min.css" integrity="sha256-916EbMg70RQy9LHiGkXzG8hSg9EdNy97GazNG/aiY1w=" crossorigin="anonymous" />

<script src="https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/3.3.7/js/bootstrap.min.js" integrity="sha256-U5ZEeKfGNOja007MMD3YBI0A3OSZOQbeG6z2f2Y0hu8=" crossorigin="anonymous"></script>

<!-- Font Awesome icons -->
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/4.7.0/css/font-awesome.min.css" integrity="sha256-eZrrJcwDc/3uDhsdt61sL2oOBY362qM3lon1gyExkL0=" crossorigin="anonymous" />

<!-- clipboard.js -->
<script src="https://cdnjs.cloudflare.com/ajax/libs/clipboard.js/2.0.4/clipboard.min.js" integrity="sha256-FiZwavyI2V6+EXO1U+xzLG3IKldpiTFf3153ea9zikQ=" crossorigin="anonymous"></script>

<!-- sticky kit -->
<script src="https://cdnjs.cloudflare.com/ajax/libs/sticky-kit/1.1.3/sticky-kit.min.js" integrity="sha256-c4Rlo1ZozqTPE2RLuvbusY3+SU1pQaJC0TjuhygMipw=" 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="Enhances twitter actor network graph by adding user attributes to nodes — vosonSML::AddTwitterUserData" />
<meta property="og:description" content="Creates a network from the relations and users dataframes generated by Create. Network is supplemented with 
additional downloaded twitter user information applied as node attributes." />
<meta name="twitter:card" content="summary" />




<!-- 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>
    <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="Released version">0.29.0</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-o"></span>
     
    News
  </a>
</li>
<li>
  <a href="../reference/index.html">
    <span class="fa fa-cubes"></span>
     
    Reference
  </a>
</li>
      </ul>
      <ul class="nav navbar-nav navbar-right">
        <li>
  <a href="https://github.com/vosonlab/vosonSML">
    <span class="fa 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>Enhances twitter actor network graph by adding user attributes to nodes</h1>
    <small class="dont-index">Source: <a href='https://github.com/vosonlab/vosonSML/blob/master/R/AddTwitterUserData.R'><code>R/AddTwitterUserData.R</code></a></small>
    <div class="hidden name"><code>vosonSML-colon-colon-AddTwitterUserData.Rd</code></div>
    </div>

    <div class="ref-description">
    <p>Creates a network from the relations and users dataframes generated by Create. Network is supplemented with 
additional downloaded twitter user information applied as node attributes.</p>
    </div>

    <pre class="usage"><span class='fu'>AddTwitterUserData</span>(<span class='no'>collectData</span>, <span class='no'>networkData</span>, <span class='kw'>lookupUsers</span> <span class='kw'>=</span> <span class='fl'>TRUE</span>,
  <span class='kw'>twitterAuth</span> <span class='kw'>=</span> <span class='kw'>NULL</span>, <span class='kw'>writeToFile</span> <span class='kw'>=</span> <span class='fl'>FALSE</span>)</pre>

    <h2 class="hasAnchor" id="arguments"><a class="anchor" href="#arguments"></a>Arguments</h2>
    <table class="ref-arguments">
    <colgroup><col class="name" /><col class="desc" /></colgroup>
    <tr>
      <th>collectData</th>
      <td><p>A dataframe containing the collected tweet data from the <code>Collect</code> function.</p></td>
    </tr>
    <tr>
      <th>networkData</th>
      <td><p>A named list containing the relations <code>$relations</code> and users <code>$users</code> data returned 
from the <code>Create</code> actor network function.</p></td>
    </tr>
    <tr>
      <th>lookupUsers</th>
      <td><p>Logical. Lookup user profile information using the twitter API for any users data missing from 
the collect data set. For example fetches profile information for users that became nodes during network creation 
because they were mentioned in a tweet but did not author any tweets themselves. Default is <code>TRUE</code>.</p></td>
    </tr>
    <tr>
      <th>twitterAuth</th>
      <td><p>A twitter authentication object from <code>Authenticate</code>.</p></td>
    </tr>
    <tr>
      <th>writeToFile</th>
      <td><p>Logical. If <code>TRUE</code> a data frame of user information and the resulting network graph will 
be written to file in <code>rds</code> and <code>graphml</code> formats respectively. Default is <code>FALSE</code>.</p></td>
    </tr>
    </table>

    <h2 class="hasAnchor" id="value"><a class="anchor" href="#value"></a>Value</h2>

    <p>A named list containing a dataframe with user information <code>$users</code> and an igraph object of the twitter 
actor network with supplemental user node attributes <code>$graph</code>.</p>
    <h2 class="hasAnchor" id="note"><a class="anchor" href="#note"></a>Note</h2>

    <p>Only supports twitter actor network at this time. Bimodal network support could be achieved by the filtering 
of the twitter user ids from nodes of other types in the <code>networkData</code>. Refer to S3 methods 
<code><a href='Authenticate.twitter.html'>Authenticate.twitter</a></code>, <code><a href='Collect.twitter.html'>Collect.twitter</a></code> and <code><a href='Create.actor.twitter.html'>Create.actor.twitter</a></code> to first 
create twitter actor network and data to pass as input into this function.</p>

    <h2 class="hasAnchor" id="examples"><a class="anchor" href="#examples"></a>Examples</h2>
    <pre class="examples"><span class='co'># NOT RUN {</span>
<span class='co'># add additional twitter user profile information to actor network graph as node attributes </span>
<span class='co'># requires twitterAuth from Authenticate, twitterData from Collect and actorNetwork from </span>
<span class='co'># Create actor network</span>
<span class='no'>actorNetWithUserAttr</span> <span class='kw'>&lt;-</span> <span class='fu'>AddTwitterUserData</span>(<span class='no'>twitterData</span>, <span class='no'>actorNetwork</span>,
                                           <span class='kw'>lookupUsers</span> <span class='kw'>=</span> <span class='fl'>TRUE</span>,
                                           <span class='kw'>twitterAuth</span> <span class='kw'>=</span> <span class='no'>twitterAuth</span>, <span class='kw'>writeToFile</span> <span class='kw'>=</span> <span class='fl'>TRUE</span>)
<span class='co'># igraph object</span>
<span class='co'># actorNetWithUserAttr$graph</span>
<span class='co'># }</span><div class='input'>
</div></pre>
  </div>
  <div class="col-md-3 hidden-xs hidden-sm" id="sidebar">
    <h2>Contents</h2>
    <ul class="nav nav-pills nav-stacked">
      <li><a href="#arguments">Arguments</a></li>
      <li><a href="#value">Value</a></li>
      <li><a href="#note">Note</a></li>
      <li><a href="#examples">Examples</a></li>
    </ul>

  </div>
</div>

      <footer>
      <div class="copyright">
  <p>Developed by <a href='https://vosonlab.net'><span>VOSON Lab</span></a>.</p>
</div>

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

  

  </body>
</html>

