Skip to content

uribo/textlintr

main
Switch branches/tags

Name already in use

A tag already exists with the provided branch name. Many Git commands accept both tag and branch names, so creating this branch may cause unexpected behavior. Are you sure you want to create this branch?
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
R
 
 
 
 
 
 
man
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

textlintr

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(
   "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

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.

About

βœ… Natural Language Linter Tools for 'R Markdown' and R Code πŸ’―

Topics

Resources

License

Unknown, MIT licenses found

Licenses found

Unknown
LICENSE
MIT
LICENSE.md

Code of conduct

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 4

  •  
  •  
  •  
  •  

Languages