docs/index.html

<!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>Quantitative Analysis of Textual Data • quanteda</title>
<!-- jquery --><script src="https://cdnjs.cloudflare.com/ajax/libs/jquery/3.4.1/jquery.min.js" integrity="sha256-CSXorXvZcTkaix6Yvo6HppcZGetbYMGWSFlBw8HfCJo=" crossorigin="anonymous"></script><!-- Bootstrap --><link href="https://cdnjs.cloudflare.com/ajax/libs/bootswatch/3.4.0/readable/bootstrap.min.css" rel="stylesheet" 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><!-- docsearch --><script src="docsearch.js"></script><link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/docsearch.js/2.6.3/docsearch.min.css" integrity="sha256-QOSRU/ra9ActyXkIBbiIB144aDBdtvXBcNc3OTNuX/Q=" crossorigin="anonymous">
<link href="docsearch.css" rel="stylesheet">
<script src="https://cdnjs.cloudflare.com/ajax/libs/mark.js/8.11.1/jquery.mark.min.js" integrity="sha256-4HLtjeVgH0eIB3aZ9mLYF6E8oU5chNdjU6p6rrXpl9U=" crossorigin="anonymous"></script><link href="extra.css" rel="stylesheet">
<script src="extra.js"></script><meta property="og:title" content="Quantitative Analysis of Textual Data">
<meta property="og:description" content="A fast, flexible, and comprehensive framework for 
    quantitative text analysis in R.  Provides functionality for corpus management,
    creating and manipulating tokens and n-grams, exploring keywords in context, 
    forming and manipulating sparse matrices
    of documents by features and feature co-occurrences, analyzing keywords, computing feature similarities and
    distances, applying content dictionaries, applying supervised and unsupervised machine learning, 
    visually representing text and text analyses, and more. ">
<!-- 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]--><!-- Global site tag (gtag.js) - Google Analytics --><script async src="https://www.googletagmanager.com/gtag/js?id=UA-144616-24"></script><script>
  window.dataLayer = window.dataLayer || [];
  function gtag(){dataLayer.push(arguments);}
  gtag('js', new Date());

  gtag('config', 'UA-144616-24');
</script>
</head>
<body data-spy="scroll" data-target="#toc">
    

    <div class="container template-home">
      <header><div class="navbar navbar-inverse 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">quanteda</a>
        <span class="version label label-default" data-toggle="tooltip" data-placement="bottom" title="">3.2.4</span>
      </span>
    </div>

    <div id="navbar" class="navbar-collapse collapse">
      <ul class="nav navbar-nav">
<li class="dropdown">
  <a href="#" class="dropdown-toggle" data-toggle="dropdown" role="button" data-bs-toggle="dropdown" aria-expanded="false">
    Quick Start
     
    <span class="caret"></span>
  </a>
  <ul class="dropdown-menu" role="menu">
<li>
      <a href="articles/quickstart.html">Quick Start Guide</a>
    </li>
    <li>
      <a href="articles/pkgdown/quickstart_es.html">Guía de Inicio Rápido</a>
    </li>
    <li>
      <a href="articles/pkgdown/quickstart_cn.html">快速入门指南</a>
    </li>
    <li>
      <a href="articles/pkgdown/quickstart_ja.html">クイック・スタートガイド</a>
    </li>
    <li>
      <a href="articles/pkgdown/quickstart_hi.html">त्वरित आरंभ </a>
    </li>
  </ul>
</li>
<li>
  <a href="reference/index.html">Reference</a>
</li>
<li class="dropdown">
  <a href="#" class="dropdown-toggle" data-toggle="dropdown" role="button" data-bs-toggle="dropdown" aria-expanded="false">
    Features
     
    <span class="caret"></span>
  </a>
  <ul class="dropdown-menu" role="menu">
<li>
      <a href="articles/pkgdown/comparison.html">Feature comparison</a>
    </li>
    <li>
      <a href="articles/pkgdown/design.html">Package design</a>
    </li>
    <li>
      <a href="news/index.html">Changelog</a>
    </li>
  </ul>
</li>
<li class="dropdown">
  <a href="#" class="dropdown-toggle" data-toggle="dropdown" role="button" data-bs-toggle="dropdown" aria-expanded="false">
    Examples
     
    <span class="caret"></span>
  </a>
  <ul class="dropdown-menu" role="menu">
<li>
      <a href="articles/pkgdown/examples/phrase.html">Multi-word expressions</a>
    </li>
    <li>
      <a href="articles/pkgdown/examples/plotting.html">Textual data visualization</a>
    </li>
    <li>
      <a href="articles/pkgdown/examples/lsa.html">Latent Semantic Analysis (LSA)</a>
    </li>
    <li>
      <a href="articles/pkgdown/examples/chinese.html">Chinese text analysis</a>
    </li>
    <li>
      <a href="articles/pkgdown/examples/twitter.html">Social media analysis</a>
    </li>
  </ul>
</li>
<li class="dropdown">
  <a href="#" class="dropdown-toggle" data-toggle="dropdown" role="button" data-bs-toggle="dropdown" aria-expanded="false">
    Replications
     
    <span class="caret"></span>
  </a>
  <ul class="dropdown-menu" role="menu">
<li>
      <a href="articles/pkgdown/replication/digital-humanities.html">Text Analysis with R for Students of Literature</a>
    </li>
    <li>
      <a href="articles/pkgdown/replication/text2vec.html">Word embedding (word2vec)</a>
    </li>
    <li>
      <a href="articles/pkgdown/replication/qss.html">Quantitative Social Science Ch. 5.1</a>
    </li>
  </ul>
</li>
      </ul>
<ul class="nav navbar-nav navbar-right">
<li>
  <a href="https://github.com/quanteda/quanteda" class="external-link">
    <span class="fa fa-github fa-lg"></span>
     
  </a>
</li>
      </ul>
<form class="navbar-form navbar-right hidden-xs hidden-sm" role="search">
        <div class="form-group">
          <input type="search" class="form-control" name="search-input" id="search-input" placeholder="Search..." aria-label="Search for..." autocomplete="off">
</div>
      </form>
      
    </div>
<!--/.nav-collapse -->
  </div>
<!--/.container -->
</div>
<!--/.navbar -->

      
      </header><div class="row">
  <div class="contents col-md-9">
<div class="section level1">
<div class="page-header"><h1 id="quanteda-quantitative-analysis-of-textual-data">quanteda: Quantitative Analysis of Textual Data<a class="anchor" aria-label="anchor" href="#quanteda-quantitative-analysis-of-textual-data"></a>
</h1></div>
<p><strong>quanteda</strong> is an R package for managing and analyzing textual data developed by <a href="http://kenbenoit.net" class="external-link">Kenneth Benoit</a>, <a href="https://blog.koheiw.net/" class="external-link">Kohei Watanabe</a>, and other contributors. Its initial development was supported by the European Research Council grant ERC-2011-StG 283794-QUANTESS.</p>
<p>The package is designed for R users needing to apply natural language processing to texts, from documents to final analysis. Its capabilities match or exceed those provided in many end-user software applications, many of which are expensive and not open source. The package is therefore of great benefit to researchers, students, and other analysts with fewer financial resources. While using <strong>quanteda</strong> requires R programming knowledge, its API is designed to enable powerful, efficient analysis with a minimum of steps. By emphasizing consistent design, furthermore, <strong>quanteda</strong> lowers the barriers to learning and using NLP and quantitative text analysis even for proficient R programmers.</p>
<div class="section level2">
<h2 id="quanteda-version-3-new-major-release">
<strong>quanteda</strong> version 3: New major release<a class="anchor" aria-label="anchor" href="#quanteda-version-3-new-major-release"></a>
</h2>
<p><strong>quanteda</strong> 3.0 is a major release that improves functionality, completes the modularisation of the package begun in v2.0, further improves function consistency by removing previously deprecated functions, and enhances workflow stability and consistency by deprecating some shortcut steps built into some functions.</p>
<p>See <a href="https://github.com/quanteda/quanteda/blob/master/NEWS.md#quanteda-30" class="external-link uri">https://github.com/quanteda/quanteda/blob/master/NEWS.md#quanteda-30</a> for a full list of the changes.</p>
</div>
<div class="section level2">
<h2 id="the-quanteda-family-of-packages">The <strong>quanteda</strong> family of packages<a class="anchor" aria-label="anchor" href="#the-quanteda-family-of-packages"></a>
</h2>
<p>As of v3.0, we have continued our trend of splitting <strong>quanteda</strong> into modular packages. These are now the following:</p>
<ul>
<li>
<strong>quanteda</strong>: contains all of the core natural language processing and textual data management functions</li>
<li>
<strong>quanteda.textmodels</strong>: contains all of the text models and supporting functions, namely the <code>textmodel_*()</code> functions. This was split from the main package with the v2 release</li>
<li>
<strong>quanteda.textstats</strong>: statistics for textual data, namely the <code>textstat_*()</code> functions, split with the v3 release</li>
<li>
<strong>quanteda.textplots</strong>: plots for textual data, namely the <code>textplot_*()</code> functions, split with the v3 release</li>
</ul>
<p>We are working on additional package releases, available in the meantime from our GitHub pages:</p>
<ul>
<li>
<strong>quanteda.sentiment</strong>: Functions and lexicons for sentiment analysis using dictionaries</li>
<li>
<strong>quanteda.tidy</strong>: Extensions for manipulating document variables in core <strong>quanteda</strong> objects using your favourite <strong>tidyverse</strong> functions</li>
</ul>
<p>and more to come.</p>
</div>
<div class="section level2">
<h2 id="how-to">How To…<a class="anchor" aria-label="anchor" href="#how-to"></a>
</h2>
<div class="section level3">
<h3 id="how-to-install">How to Install<a class="anchor" aria-label="anchor" href="#how-to-install"></a>
</h3>
<p>The normal way from CRAN, using your R GUI or</p>
<div class="sourceCode" id="cb1"><pre class="sourceCode R"><code class="sourceCode r"><span id="cb1-1"><a href="#cb1-1" aria-hidden="true" tabindex="-1"></a><span class="fu">install.packages</span>(<span class="st">"quanteda"</span>) </span></code></pre></div>
<p>Or for the latest development version:</p>
<div class="sourceCode" id="cb2"><pre class="sourceCode R"><code class="sourceCode r"><span id="cb2-1"><a href="#cb2-1" aria-hidden="true" tabindex="-1"></a><span class="co"># devtools package required to install quanteda from Github </span></span>
<span id="cb2-2"><a href="#cb2-2" aria-hidden="true" tabindex="-1"></a>remotes<span class="sc">::</span><span class="fu">install_github</span>(<span class="st">"quanteda/quanteda"</span>) </span></code></pre></div>
<p>Because this compiles some C++ and Fortran source code, you will need to have installed the appropriate compilers to build the development version.</p>
</div>
<div class="section level3">
<h3 id="how-to-use">How to Use<a class="anchor" aria-label="anchor" href="#how-to-use"></a>
</h3>
<p>See the <a href="https://quanteda.io/articles/pkgdown/quickstart.html">quick start guide</a> to learn how to use <strong>quanteda</strong>.</p>
</div>
<div class="section level3">
<h3 id="how-to-get-help">How to Get Help<a class="anchor" aria-label="anchor" href="#how-to-get-help"></a>
</h3>
<ul>
<li>Read out documentation at <a href="https://quanteda.io" class="uri">https://quanteda.io</a>.</li>
<li>Submit a question on the <a href="https://stackoverflow.com/questions/tagged/quanteda" class="external-link"><strong>quanteda</strong> channel on StackOverflow</a>.</li>
<li>See our <a href="https://tutorials.quanteda.io/" class="external-link">tutorial site</a>.</li>
</ul>
</div>
<div class="section level3">
<h3 id="how-to-cite">How to Cite<a class="anchor" aria-label="anchor" href="#how-to-cite"></a>
</h3>
<p>Benoit, Kenneth, Kohei Watanabe, Haiyan Wang, Paul Nulty, Adam Obeng, Stefan Müller, and Akitaka Matsuo. (2018) “<a href="https://www.theoj.org/joss-papers/joss.00774/10.21105.joss.00774.pdf" class="external-link">quanteda: An R package for the quantitative analysis of textual data</a>”. <em>Journal of Open Source Software</em>. 3(30), 774. <a href="https://doi.org/10.21105/joss.00774" class="external-link uri">https://doi.org/10.21105/joss.00774</a>.</p>
<p>For a BibTeX entry, use the output from <code>citation(package = "quanteda")</code>.</p>
</div>
<div class="section level3">
<h3 id="how-to-leave-feedback">How to Leave Feedback<a class="anchor" aria-label="anchor" href="#how-to-leave-feedback"></a>
</h3>
<p>If you like <strong>quanteda</strong>, please consider leaving <a href="https://github.com/quanteda/quanteda/issues/461" class="external-link">feedback or a testimonial here</a>.</p>
</div>
<div class="section level3">
<h3 id="how-to-contribute">How to Contribute<a class="anchor" aria-label="anchor" href="#how-to-contribute"></a>
</h3>
<p>Contributions in the form of feedback, comments, code, and bug reports are most welcome. How to contribute:</p>
<ul>
<li>Fork the source code, modify, and issue a <a href="https://help.github.com/articles/creating-a-pull-request-from-a-fork/" class="external-link">pull request</a> through the <a href="https://github.com/quanteda/quanteda" class="external-link">project GitHub page</a>. See our <a href="https://github.com/quanteda/quanteda/blob/master/CONDUCT.md" class="external-link">Contributor Code of Conduct</a> and the all-important <strong>quanteda</strong> <a href="https://github.com/quanteda/quanteda/wiki/Style-guide" class="external-link">Style Guide</a>.</li>
<li>Issues, bug reports, and wish lists: <a href="https://github.com/quanteda/quanteda/issues" class="external-link">File a GitHub issue</a>.</li>
<li>Contact <a href="mailto:kbenoit@lse.ac.uk">the maintainer</a> by email.</li>
</ul>
</div>
</div>
</div>
  </div>

  <div class="col-md-3 hidden-xs hidden-sm" id="pkgdown-sidebar">
    <div class="links">
<h2 data-toc-skip>Links</h2>
<ul class="list-unstyled">
<li><a href="https://cloud.r-project.org/package=quanteda" class="external-link">View on CRAN</a></li>
<li><a href="https://github.com/quanteda/quanteda/" class="external-link">Browse source code</a></li>
<li><a href="https://github.com/quanteda/quanteda/issues" class="external-link">Report a bug</a></li>
</ul>
</div>

<div class="license">
<h2 data-toc-skip>License</h2>
<ul class="list-unstyled">
<li><a href="https://www.r-project.org/Licenses/GPL-3" class="external-link">GPL-3</a></li>
</ul>
</div>


<div class="citation">
<h2 data-toc-skip>Citation</h2>
<ul class="list-unstyled">
<li><a href="authors.html#citation">Citing quanteda</a></li>
</ul>
</div>

<div class="developers">
<h2 data-toc-skip>Developers</h2>
<ul class="list-unstyled">
<li>Kenneth Benoit <br><small class="roles"> Maintainer, author, copyright holder </small> <a href="https://orcid.org/0000-0002-0797-564X" target="orcid.widget" aria-label="ORCID" class="external-link"><span class="fab fa-orcid orcid" aria-hidden="true"></span></a> </li>
<li>Kohei Watanabe <br><small class="roles"> Author </small> <a href="https://orcid.org/0000-0001-6519-5265" target="orcid.widget" aria-label="ORCID" class="external-link"><span class="fab fa-orcid orcid" aria-hidden="true"></span></a> </li>
<li>Haiyan Wang <br><small class="roles"> Author </small> <a href="https://orcid.org/0000-0003-4992-4311" target="orcid.widget" aria-label="ORCID" class="external-link"><span class="fab fa-orcid orcid" aria-hidden="true"></span></a> </li>
<li>Paul Nulty <br><small class="roles"> Author </small> <a href="https://orcid.org/0000-0002-7214-4666" target="orcid.widget" aria-label="ORCID" class="external-link"><span class="fab fa-orcid orcid" aria-hidden="true"></span></a> </li>
<li>Adam Obeng <br><small class="roles"> Author </small> <a href="https://orcid.org/0000-0002-2906-4775" target="orcid.widget" aria-label="ORCID" class="external-link"><span class="fab fa-orcid orcid" aria-hidden="true"></span></a> </li>
<li>Stefan Müller <br><small class="roles"> Author </small> <a href="https://orcid.org/0000-0002-6315-4125" target="orcid.widget" aria-label="ORCID" class="external-link"><span class="fab fa-orcid orcid" aria-hidden="true"></span></a> </li>
<li>Akitaka Matsuo <br><small class="roles"> Author </small> <a href="https://orcid.org/0000-0002-3323-6330" target="orcid.widget" aria-label="ORCID" class="external-link"><span class="fab fa-orcid orcid" aria-hidden="true"></span></a> </li>
<li>William Lowe <br><small class="roles"> Author </small> <a href="https://orcid.org/0000-0002-1549-6163" target="orcid.widget" aria-label="ORCID" class="external-link"><span class="fab fa-orcid orcid" aria-hidden="true"></span></a> </li>
<li>European Research Council <br><small class="roles"> Funder </small>  </li>
<li><a href="authors.html">More about authors...</a></li>
</ul>
</div>


  </div>
</div>


      <footer><div class="copyright">
  <p></p>
<p>Developed by Kenneth Benoit, Kohei Watanabe, Haiyan Wang, Paul Nulty, Adam Obeng, Stefan Müller, Akitaka Matsuo, William Lowe, European Research Council.</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.6.</p>
</div>

      </footer>
</div>

  
<script src="https://cdnjs.cloudflare.com/ajax/libs/docsearch.js/2.6.1/docsearch.min.js" integrity="sha256-GKvGqXDznoRYHCwKXGnuchvKSwmx9SRMrZOTh2g4Sb0=" crossorigin="anonymous"></script><script>
  docsearch({
    
    
    apiKey: '9b4ef7fd791dc6075154d3ebd7b12acf',
    indexName: 'quanteda',
    inputSelector: 'input#search-input.form-control',
    transformData: function(hits) {
      return hits.map(function (hit) {
        hit.url = updateHitURL(hit);
        return hit;
      });
    }
  });
</script>
</body>
</html>