search

ropensci / unconf17

Website for 2017 rOpenSci Unconf
http://unconf17.ropensci.org
64 stars 12 forks source link

The grammar of grammar #53

Open jasdumas opened 7 years ago

jasdumas commented 7 years ago

Writing reports in RMarkdown has improved the way I communicate insights alongside code contained in one document, but I have spent numerous times re-working reports to remove silly mistakes in spelling and general grammar that the spell check in RStudio does not catch 😞

Project idea: Develop a package/tool that checks for grammar and avoids some obvious programming nomenclature in spelling such as:

  1. hex color codes

  2. known package names

  3. file extensions

  4. misspellings in comments or yaml header sections

The obvious alternatives are to use MS Word or Google Docs but I do enjoy just doing things in RStudio! (And I'm aware that this ticket basically admits that I'm bad at spelling and grammar)

benmarwick commented 7 years ago

This is a great suggestion, it could take the form of an RStudio add-in that wraps up https://github.com/btford/write-good for R

jasdumas commented 7 years ago

I'm still interested in this project as the second sub-bullet point from https://github.com/ropensci/unconf17/issues/5#issuecomment-302058661 incorporated as part of a testing package - anyone else?

jasdumas commented 7 years ago

I'm going to be working on this also today: https://github.com/ropenscilabs/gramr

naupaka commented 7 years ago

In addition to write-good, there's also vale which has a neat plugin system.

jasdumas commented 7 years ago

^ nice! Currenlty trying to wrap write-good in V8

stefaniebutland commented 7 years ago

Repo: https://github.com/ropenscilabs/gramr