https://github.com/uribo/textlintr

✅ Natural Language Linter Tools for 'R Markdown' and R Code 💯
https://github.com/uribo/textlintr

lint natural-language-processing r-package

Last synced: about 2 months ago
JSON representation

✅ Natural Language Linter Tools for 'R Markdown' and R Code 💯

• Host: GitHub
• URL: https://github.com/uribo/textlintr
• Owner: uribo
• License: other
• Created: 2018-09-30T14:00:13.000Z (almost 6 years ago)
• Default Branch: main
• Last Pushed: 2022-10-21T02:28:02.000Z (almost 2 years ago)
• Last Synced: 2024-05-21T02:12:55.751Z (4 months ago)
• Topics: lint, natural-language-processing, r-package
• Language: R
• Homepage: https://uribo.github.io/textlintr/
• Size: 394 KB
• Stars: 8
• Watchers: 5
• Forks: 1
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE
  • Code of conduct: .github/CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
textlintr

=========

[![CRAN status](https://www.r-pkg.org/badges/version/textlintr)](https://cran.r-project.org/package=textlintr) [![Lifecycle: experimental](https://img.shields.io/badge/lifecycle-experimental-orange.svg)](https://www.tidyverse.org/lifecycle/#experimental) [![Codecov test coverage](https://codecov.io/gh/uribo/textlintr/branch/master/graph/badge.svg)](https://codecov.io/gh/uribo/textlintr?branch=main)

Textlintr is package that wrapper natural language lint tools [`textlint.js`](https://textlint.github.io/) for R. You can combine rules freely to check for misspellings and so on.

Installation

------------

You can install the development version of textlintr from [GitHub](https://github.com/uribo/textlintr) with:

``` r

install.packages(

   "textlintr", 

   repos = "https://uribo.r-universe.dev")

```

Get Started

-----------

1. Initialise textlint environments (install `textlint.js` and some rules)

    - `init_textlintr(rules = c("common-misspellings", "prh"))`

    - A list of rules can be confirmed with `rule_sets()`

2. Configure `.textlintrc`

3. Run `textlint("target.Rmd")`

4. Want to add a rule? --- You can supplement rules by running `add_rule()`

### Demo

``` r

library(textlintr)

init_textlintr(rules = c("common-misspellings"))

lint_target <- 

  system.file("sample.md", package = "textlintr")

textlint(lint_target)

```







Code of Conduct

-----------

The environment for collaboration should be friendly, inclusive, respectful, and safe for everyone, so all participants must obey this repository’s [code of conduct](.github/CODE_OF_CONDUCT.md).