README.Rmd

---
output: github_document
---

```{r, echo = FALSE}
knitr::opts_chunk$set(
  collapse = TRUE,
  comment = "##",
  fig.path = "man/images/"
)
```
```{r echo=FALSE, results="hide", message=FALSE}
library("badger")
```

# quanteda.textstats: textual statistics for quanteda

<!-- badges: start -->
[![CRAN Version](https://www.r-pkg.org/badges/version/quanteda.textstats)](https://CRAN.R-project.org/package=quanteda.textstats)
`r badge_devel("quanteda/quanteda.textstats", "royalblue")`
[![Downloads](https://cranlogs.r-pkg.org/badges/quanteda.textstats)](https://CRAN.R-project.org/package=quanteda.textstats)
[![Total Downloads](https://cranlogs.r-pkg.org/badges/grand-total/quanteda.textstats?color=orange)](https://CRAN.R-project.org/package=quanteda.textstats)
[![Codecov test coverage](https://codecov.io/gh/quanteda/quanteda.textstats/branch/master/graph/badge.svg)](https://app.codecov.io/gh/quanteda/quanteda.textstats?branch=master)
[![R-CMD-check](https://github.com/quanteda/quanteda.textstats/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/quanteda/quanteda.textstats/actions/workflows/R-CMD-check.yaml)
<!-- badges: end -->

## About

Contains the textstat functions formerly in **quanteda**.  For more details, see https://quanteda.io.

## How to Install

The normal way from CRAN, using your R GUI or 
```{r eval = FALSE}
install.packages("quanteda.textstats") 
```

Or for the latest development version:
```{r eval = FALSE}
# devtools package required to install quanteda from Github 
remotes::install_github("quanteda/quanteda.textstats") 
```

Because this compiles some C++ and Fortran source code, you will need to have installed the appropriate compilers.

**If you are using a Windows platform**, this means you will need also to install
the [Rtools](https://CRAN.R-project.org/bin/windows/Rtools/) software available
from CRAN.  

**If you are using macOS**, you should install the 
[macOS tools](https://cran.r-project.org/bin/macosx/tools/), 
namely the Clang 6.x compiler and the GNU Fortran compiler (as **quanteda.textstats** requires gfortran to build).  If you are still getting errors related to gfortran, follow the fixes [here](https://thecoatlessprofessor.com/programming/rcpp-rcpparmadillo-and-os-x-mavericks--lgfortran-and--lquadmath-error/).  
    
## How to cite

Benoit, Kenneth, Kohei Watanabe, Haiyan Wang, Paul Nulty, Adam Obeng, Stefan Müller, and Akitaka Matsuo.  (2018) "[quanteda: An R package for the quantitative analysis of textual data](https://www.theoj.org/joss-papers/joss.00774/10.21105.joss.00774.pdf)".  _Journal of Open Source Software_.  3(30), 774. [https://doi.org/10.21105/joss.00774](https://doi.org/10.21105/joss.00774).

For a BibTeX entry, use the output from `citation(package = "quanteda.textstats")`.