Skip to content
Natural Language Linter Tools for 'R Markdown' and R Code 💯
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github
R
inst
man
tests
.Rbuildignore
.gitignore
.lintr
.travis.yml
DESCRIPTION
Dockerfile
LICENSE
LICENSE.md
NAMESPACE
NEWS.md
README.md
appveyor.yml
codecov.yml
docker-compose.yml
textlintr.Rproj
tic.R

README.md

textlintr

Travis-CI Build Status AppVeyor Build Status CRAN status Lifecycle: experimental Codecov test coverage

Textlintr is package that wrapper natural language lint tools textlint.js 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 with:

# install.packages("remotes")
remotes::install_github("uribo/textlintr")

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.md")
  4. Want to add a rule? --- You can supplement rules by running add_rule()

Demo

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.

You can’t perform that action at this time.