Skip to content

Commit

Permalink
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
also include checklist
Browse files Browse the repository at this point in the history
IndrajeetPatil committed Sep 29, 2024
1 parent 0acef09 commit 8705a34
Showing 3 changed files with 14 additions and 3 deletions.
2 changes: 1 addition & 1 deletion paper/paper.Rmd
Original file line number Diff line number Diff line change
@@ -219,7 +219,7 @@ There are two main ways to customize it:

- Create new linters (by leveraging functions like `lintr::make_linter_from_xpath()`) tailored to match project- or organization-specific coding standards.

Indeed, `{goodpractice}` [@Padgham2024] bundles a set of custom linters that are not part of the default set of `{lintr}` linters, while `{flint}` [@Bacher2024] provides a way to fix the lints detected by `{lintr}`. Moreover, `{box.linters}` [@Basa2024] extends `{lintr}` to support `{box}` modules [@Rudolph2024].
Indeed, `{goodpractice}` [@Padgham2024] bundles a set of custom linters that are not part of the default set of `{lintr}` linters, while `{flint}` [@Bacher2024] provides a way to fix the lints detected by `{lintr}`. Moreover, `{box.linters}` [@Basa2024] extends `{lintr}` to support `{box}` modules [@Rudolph2024], while `{checklist}` includes linters as one of the strict checks for R packages [@Onkelinx2024].

# Benefits of using `{lintr}`

10 changes: 10 additions & 0 deletions paper/paper.bib
Original file line number Diff line number Diff line change
@@ -105,3 +105,13 @@ @Manual{Wickham2024roxy
note = {R package version 7.3.2},
url = {https://CRAN.R-project.org/package=roxygen2},
}

@Manual{Onkelinx2024,
title = {checklist: A Thorough and Strict Set of Checks for {R} Packages and Source Code. Version 0.4.0},
author = {Thierry Onkelinx},
year = {2024},
url = {https://inbo.github.io/checklist/},
abstract = {An opinionated set of rules for R packages and R source code projects.},
keywords = {quality control; documentation; publication},
doi = {10.5281/zenodo.4028303},
}
5 changes: 3 additions & 2 deletions paper/paper.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "Static Code Analysis for R"
date: "2024-09-28"
date: "2024-09-29"
tags: ["R", "linter", "tidyverse"]
authors:
- name: Jim Hester
@@ -298,7 +298,8 @@ Indeed, `{goodpractice}` [@Padgham2024] bundles a set of custom linters
that are not part of the default set of `{lintr}` linters, while
`{flint}` [@Bacher2024] provides a way to fix the lints detected by
`{lintr}`. Moreover, `{box.linters}` [@Basa2024] extends `{lintr}` to
support `{box}` modules [@Rudolph2024].
support `{box}` modules [@Rudolph2024], while `{checklist}` includes
linters as one of the strict checks for R packages [@Onkelinx2024].

# Benefits of using `{lintr}`

0 comments on commit 8705a34

Please sign in to comment.