Skip to contents

Writing checks

Source: R/writingChecks.R
writingChecks.Rd

Check an R markdown file (.Rmd) for word count, spelling and grammatical errors.

Usage

writingChecks(
  file = "manuscript.Rmd",
  checks = c("word count", "spelling", "grammar")
)

Arguments

file

Path to a .Rmd file to check.

checks

Character vector of checks to perform.

Value

None. Check results are printed to the console.

Examples

 file_path <- system.file('example.Rmd',package = 'jfmisc')
 writingChecks(file_path)
#> ######### Writing Checks #########
#> 
#> Word count
#> 
#> |Method          |koRpus      |stringi       |
#> |:---------------|:-----------|:-------------|
#> |Word count      |103         |102           |
#> |Character count |591         |590           |
#> |Sentence count  |8           |Not available |
#> |Reading time    |0.5 minutes |0.5 minutes   |
#> 
#> Spelling
#> 
#> No spelling errors found.
#> 
#> Grammar
#> 
#> | index| offset|reason                              |
#> |-----:|------:|:-----------------------------------|
#> |   354|     12|"be generated" may be passive voice |
#> |   682|      9|"was added" may be passive voice    |