cran-task-views / cran-task-views/ReproducibleResearch

Suggestion: jsslintr (style checking for JSS manuscripts)

Open Beginner friendly
#27 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
R
Stars
19
Forks
3
PR merge metrics
No merged PRs in 30d

Description

I'd like to suggest jsslintr for the task view, plausibly under the "LaTeX" or literate-programming/publishing tools section.

jsslintr (https://cran.r-project.org/package=jsslintr) checks manuscripts in Journal of Statistical Software format (.tex, .Rnw, .Rmd + .bib) against 62 deterministic rules derived from the journal's published style guide, reporting violations with positions and fix suggestions (jssfix() applies the mechanical subset). It complements the code-oriented linters already in common use (lintr, styler) by acting on the manuscript rather than the code, and its per-rule precision/recall is measured against a pinned corpus of 254 published JSS-format manuscripts.

Disclosure: I am the package author. The package is independent of and not endorsed by JSS itself.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by locating the ReproducibleResearch task-view source and reviewing how existing packages are grouped under the LaTeX or literate-programming/publishing sections. Add jsslintr with its CRAN link and described manuscript-linting purpose, then verify that the rendered task view includes it in the chosen section.

Written by the indexing model from the issue text.

Assessment

Tech stack
latex, r
Domain
documentation
Issue type
Feature
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Active
Clarity
Mostly clear
Newbie friendliness
70/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.