writingChecks: Writing checks

View source: R/writingChecks.R

writingChecksR Documentation

Writing checks

Description

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)

jasenfinch/jfmisc documentation built on Feb. 21, 2024, 7:10 a.m.