initial_check_article {rjtools}

R Documentation

A single article check

Description

A single article check

Usage

initial_check_article(path = here::here(), dic = "en_US", pkg = NULL, ...)

check_wrappers(path)

check_filenames(path)

check_unnecessary_files(path)

check_cover_letter(path)

check_title(path)

check_section(path)

check_abstract_before_intro(path)

check_spelling(path, dic = "en_US", ...)

check_proposed_pkg(pkg = NULL)

check_packages_available(path)

Arguments

path	The directory that contains the .tex file (Ideally, this directory should contain .bib, .rmd, and .tex with author names and two RJwrapper files: RJwrapper.pdf and RJwrapper.tex)
dic	The dictionary used for spelling check. See dict argument in hunspell::hunspell()
pkg	The name of the proposed package (if relevant), to be checked for activity on CRAN
...	Additional arguments for spelling check with hunspell::hunspell

Details

Folder structure checks:

• check_wrappers(): the two expected RJwrapper files (RJwrapper.tex and RJwrapper.pdf) exist

• check_filenames(): the three files (.bib, .Rmd, and .tex) all present and have consistent names

• check_unnecessary_files(): template files (i.e. RJtemplate.tex and RJournal.sty) are not included in the directory

• check_cover_letter(): a motivational letter

Content checks:

• check_title(): article title is in title case

• check_section(): section sections are in sentence case

• check_abstract_before_intro(): abstract comes before the introduction section

• check_spelling(): potential spelling mistakes

• check_proposed_pkg(): package proposed in the paper is on CRAN

• check_packages_available(): packages mentioned in the article are available on CRAN

See vignette("create_article", package = "rjtools") for how to use the check functions

---