Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

WIP: Address feedback from reviewer-2 #2683

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

WIP: Address feedback from reviewer-2 #2683

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions paper/paper.Rmd
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ withr::local_options(list(

# Statement of Need

A linter is a tool that analyzes code to identify potential errors, stylistic issues, or deviations from coding standards. It helps ensure consistency, readability, and best practices by flagging common mistakes, such as syntax errors, unused variables, or improper formatting. Linters are essential for improving code quality, preventing bugs, and maintaining a clean codebase, especially in collaborative development environments [@enwiki:1218663830]. `{lintr}` is an open-source package that provides linters for the R programming language, which is an interpreted, dynamically-typed programming language [@base2023], and is used by a wide range of researchers and data scientists. `{lintr}` can thus act as a valuable tool for R users to help improve the quality and reliability of their code.
In computer programming, "linting" is the process of analyzing the source code to identify possible programming and stylistic problems (https://en.wiktionary.org/wiki/linting) and a linter is a tool used for linting. A linter analyzes code to identify potential errors, stylistic issues, or deviations from coding standards. It helps ensure consistency, readability, and best practices by flagging common mistakes, such as syntax errors, unused variables, or improper formatting. Linters are essential for improving code quality, preventing bugs, and maintaining a clean codebase, especially in collaborative development environments [@enwiki:1218663830]. `{lintr}` is an open-source package that provides linters for the R programming language, which is an interpreted, dynamically-typed programming language [@base2023], and is used by a wide range of researchers and data scientists. `{lintr}` can thus act as a valuable tool for R users to help improve the quality and reliability of their code.

# Features

Expand All @@ -79,7 +79,7 @@ library(lintr)
length(all_linters())
```

Naturally, we can't discuss all of them here. To see details about all available linters, we encourage readers to see <https://lintr.r-lib.org/dev/reference/index.html#individual-linters>.
Naturally, we can't discuss all of them here. To see the most up-to-date details about all the available linters, we encourage readers to visit <https://lintr.r-lib.org/dev/reference/index.html#individual-linters>.

We will showcase one linter for each kind of common problem found in R code.

Expand Down
11 changes: 7 additions & 4 deletions paper/paper.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "Static Code Analysis for R"
date: "2024-10-02"
date: "2024-11-03"
tags: ["R", "linter", "tidyverse"]
authors:
- name: Jim Hester
Expand Down Expand Up @@ -51,7 +51,10 @@ link-citations: true

# Statement of Need

A linter is a tool that analyzes code to identify potential errors,
In computer programming, "linting" is the process of analyzing the
source code to identify possible programming and stylistic problems
(<https://en.wiktionary.org/wiki/linting>) and a linter is a tool used
for linting. A linter analyzes code to identify potential errors,
stylistic issues, or deviations from coding standards. It helps ensure
consistency, readability, and best practices by flagging common
mistakes, such as syntax errors, unused variables, or improper
Expand Down Expand Up @@ -86,8 +89,8 @@ length(all_linters())
#> [1] 113
```

Naturally, we can't discuss all of them here. To see details about all
available linters, we encourage readers to see
Naturally, we can't discuss all of them here. To see the most up-to-date
details about all the available linters, we encourage readers to visit
<https://lintr.r-lib.org/dev/reference/index.html#individual-linters>.

We will showcase one linter for each kind of common problem found in R
Expand Down
Loading