https://github.com/trinker/readability

Fast readability scores for text data
https://github.com/trinker/readability

r readability text-mining

Last synced: 7 days ago
JSON representation

Fast readability scores for text data

• Host: GitHub
• URL: https://github.com/trinker/readability
• Owner: trinker
• Created: 2015-08-07T02:41:19.000Z (about 9 years ago)
• Default Branch: master
• Last Pushed: 2018-09-26T02:03:12.000Z (about 6 years ago)
• Last Synced: 2024-08-06T03:05:16.240Z (3 months ago)
• Topics: r, readability, text-mining
• Language: R
• Homepage:
• Size: 175 KB
• Stars: 23
• Watchers: 4
• Forks: 4
• Open Issues: 2
• Metadata Files:
  • Readme: README.Rmd

Awesome Lists containing this project

README

        
---

title: "readability"

date: "`r format(Sys.time(), '%d %B, %Y')`"

output:

  md_document:

    toc: true      

---

```{r, echo=FALSE}

desc <- suppressWarnings(readLines("DESCRIPTION"))

regex <- "(^Version:\\s+)(\\d+\\.\\d+\\.\\d+)"

loc <- grep(regex, desc)

ver <- gsub(regex, "\\2", desc[loc])

verbadge <- sprintf('', ver, ver)

library(knitr)

````

```{r, echo=FALSE}

knit_hooks$set(htmlcap = function(before, options, envir) {

  if(!before) {

    paste('
',options$htmlcap,"
",sep="")

    }

    })

knitr::opts_knit$set(self.contained = TRUE, cache = FALSE)

knitr::opts_chunk$set(fig.path = "tools/figure/")

```


[![Project Status: Inactive – The project has reached a stable, usable state but is no longer being actively developed; support/maintenance will be provided as time allows.](https://www.repostatus.org/badges/latest/inactive.svg)](https://www.repostatus.org/#inactive)

[![Build Status](https://travis-ci.org/trinker/readability.svg?branch=master)](https://travis-ci.org/trinker/readability)

[![Coverage Status](https://coveralls.io/repos/trinker/readability/badge.svg?branch=master)](https://coveralls.io/r/trinker/readability?branch=master)

[![DOI](https://zenodo.org/badge/5398/trinker/readability.svg)](https://zenodo.org/badge/latestdoi/5398/trinker/readability)

[![](http://cranlogs.r-pkg.org/badges/readability)](https://cran.r-project.org/package=readability)

`r verbadge`

![](tools/readability_logo/r_readability.png)

**readability** utilizes the [**syllable**](https://github.com/trinker/syllable) package for fast calculation of readability scores by grouping variables.

# Installation

To download the development version of **readability**:

Download the [zip ball](https://github.com/trinker/readability/zipball/master) or [tar ball](https://github.com/trinker/readability/tarball/master), decompress and run `R CMD INSTALL` on it, or use the **pacman** package to install the development version:

```r

if (!require("pacman")) install.packages("pacman")

pacman::p_load_gh(c(

    'trinker/lexicon',

    'trinker/textclean',

    'trinker/textshape',

    "trinker/syllable", 

    "trinker/readability"

))

```

# Contact

You are welcome to:

* submit suggestions and bug-reports at: 

* send a pull request on: 

* compose a friendly e-mail to: 

# Examples 

```{r}

if (!require("pacman")) install.packages("pacman")

pacman::p_load(syllable, readability)

```

```{r, fig.width=10}

(x <- with(presidential_debates_2012, readability(dialogue, list(person, time))))

plot(x)

```