{"id":13858113,"url":"https://github.com/ropensci/spelling","last_synced_at":"2025-04-05T08:05:44.662Z","repository":{"id":41390277,"uuid":"101399529","full_name":"ropensci/spelling","owner":"ropensci","description":"Tools for Spell Checking in R","archived":false,"fork":false,"pushed_at":"2024-10-03T18:17:49.000Z","size":137,"stargazers_count":107,"open_issues_count":32,"forks_count":25,"subscribers_count":10,"default_branch":"master","last_synced_at":"2025-03-29T07:05:07.732Z","etag":null,"topics":["r","r-package","rstats","spell-check","spell-checker","spellcheck","spellchecker","spelling"],"latest_commit_sha":null,"homepage":"https://docs.ropensci.org/spelling","language":"R","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ropensci.png","metadata":{"files":{"readme":"README.md","changelog":"NEWS","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2017-08-25T11:59:13.000Z","updated_at":"2024-10-03T18:17:53.000Z","dependencies_parsed_at":"2024-09-09T21:14:59.733Z","dependency_job_id":"9d1fd2e0-12dc-4c18-996a-fa4b6561affc","html_url":"https://github.com/ropensci/spelling","commit_stats":null,"previous_names":[],"tags_count":5,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ropensci%2Fspelling","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ropensci%2Fspelling/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ropensci%2Fspelling/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ropensci%2Fspelling/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ropensci","download_url":"https://codeload.github.com/ropensci/spelling/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247305933,"owners_count":20917208,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["r","r-package","rstats","spell-check","spell-checker","spellcheck","spellchecker","spelling"],"created_at":"2024-08-05T03:01:57.049Z","updated_at":"2025-04-05T08:05:44.624Z","avatar_url":"https://github.com/ropensci.png","language":"R","funding_links":[],"categories":["R"],"sub_categories":[],"readme":"# spelling\n\n[![Project Status: Active – The project has reached a stable, usable state and is being actively developed.](http://www.repostatus.org/badges/latest/active.svg)](http://www.repostatus.org/#active)\n[![CRAN_Status_Badge](http://www.r-pkg.org/badges/version/spelling)](http://cran.r-project.org/package=spelling)\n[![CRAN RStudio mirror downloads](http://cranlogs.r-pkg.org/badges/spelling)](http://cran.r-project.org/web/packages/spelling/index.html)\n\n\u003e Tools for Spell Checking in R\n\nSpell checking common document formats including latex, markdown, manual pages,\nand description files. Includes utilities to automate checking of documentation and \nvignettes as a unit test during 'R CMD check'. Both British and American English are \nsupported out of the box and other languages can be added. In addition, packages may\ndefine a 'wordlist' to allow custom terminology without having to abuse punctuation.\n\n## Spell Check Single Files\n\nThe function `spell_check_files` automatically parses known text formats and only spell checks text blocks, not code chunks.\n\n```r\nspell_check_files('README.md', lang = 'en_US')\n#   WORD       FOUND IN\n# AppVeyor   README.md:5\n# CMD        README.md:12\n# RStudio    README.md:8\n```\n\nFor more information about the underlying spelling engine and how to add \nsupport for other languages, see the [hunspell package](https://docs.ropensci.org/hunspell/articles/intro.html#hunspell-dictionaries).\n\n![screenshot](https://jeroen.github.io/images/rs-hunspell.png)\n\n## Spell Check a Package\n\nSpell check documentation, description, readme, and vignettes of a package:\n\n```r\nspell_check_package(\"~/workspace/V8\")\n# DESCRIPTION does not contain 'Language' field. Defaulting to 'en-US'.\n#   WORD          FOUND IN\n# ECMA          V8.Rd:16, description:2,4\n# emscripten    description:5\n# htmlwidgets   JS.Rd:16\n# JSON          V8.Rd:33,38,39,57,58,59,121\n# jsonlite      V8.Rd:42\n# Ooms          V8.Rd:41,121\n# th            description:3\n# Xie           JS.Rd:26\n# Yihui         JS.Rd:26\n```\n\nReview these words and then update the wordlist to allow them:\n\n\n```r\nupdate_wordlist(\"~/workspace/V8\")\n# The following words will be added to the wordlist:\n#  - ECMA\n#  - emscripten\n#  - htmlwidgets\n#  - JSON\n#  - jsonlite\n#  - Ooms\n#  - th\n#  - Xie\n#  - Yihui\n# Are you sure you want to update the wordlist?\n# 1: Yes\n# 2: No\n```\n\nThen these will no longer be marked as errors:\n\n```r\n\u003e spell_check_package(\"~/workspace/V8\")\nNo spelling errors found.\n```\n\n## Automate Package Spell Checking\n\nUse `spell_check_setup()` to add a unit test to your package which automatically runs a spell check on documentation and vignettes during `R CMD check` if the environment variable `NOT_CRAN` is set to `TRUE`. By default this unit test never fails; it merely prints potential spelling errors to the console.\n\n\n```r\nspell_check_setup(\"~/workspace/V8\")\n# Adding 'Language: en-US' to DESCRIPTION\n# No changes required to /Users/jeroen/workspace/V8/inst/WORDLIST\n# Updated /Users/jeroen/workspace/V8/tests/spelling.R\n```\n\nNote that the `NOT_CRAN` variable is automatically set to 1 on Travis and in devtools or RStudio, otherwise you need to set it yourself:\n\n```sh\nexport NOT_CRAN=1\nR CMD check V8_1.5.9000.tar.gz\n# * using log directory ‘/Users/jeroen/workspace/V8.Rcheck’\n# * using R version 3.5.1 (2018-07-02)\n# * using platform: x86_64-apple-darwin15.6.0 (64-bit)\n# ...\n# ...\n# * checking tests ...\n#   Running ‘spelling.R’\n#   Comparing ‘spelling.Rout’ to ‘spelling.Rout.save’ ... OK\n#   Running ‘testthat.R’\n#  OK\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fropensci%2Fspelling","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fropensci%2Fspelling","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fropensci%2Fspelling/lists"}