https://github.com/fabian-s/checklist

Custom linting and checks for my programming class
https://github.com/fabian-s/checklist

Last synced: 29 days ago
JSON representation

Custom linting and checks for my programming class

• Host: GitHub
• URL: https://github.com/fabian-s/checklist
• Owner: fabian-s
• License: lgpl-2.1
• Created: 2019-08-28T09:26:07.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2022-05-28T15:34:55.000Z (over 2 years ago)
• Last Synced: 2024-11-03T15:38:23.709Z (3 months ago)
• Language: R
• Size: 43 KB
• Stars: 3
• Watchers: 2
• Forks: 0
• Open Issues: 4
• Metadata Files:
  • Readme: README.Rmd
  • License: LICENSE.md

Awesome Lists containing this project

• jimsghstars - fabian-s/checklist - Custom linting and checks for my programming class (R)

README

        
# checklist

Inspired by projects like [`{goodpractice}`](https://github.com/MangoTheCat/goodpractice) and [`{checkers}`](https://github.com/ropenscilabs/checkers), this package implements a semi-automated checklist for scripts and program files.  

Its ostensible primary purpose is to help people in my programming classes write better

code (i.e., come to grips with me being uptight and obsessive-compulsive about spaces and indentation).  

It's actual primary purpose is to save me from having to write out repetitive nagging comments about sloppy homework.

## Installation

``` r

remotes::install_github("fabian-s/checklist")

```

## Example

`{checklist}` only has one function, called `checklist`.  

The input for `checklist` is the path to a single R script file or a folder containing R scripts. 

`checklist` then runs a lot of different checks for proper formatting and sensible coding style on these. 

It is fairly likely to produce a lot of false positives, so use your judgment. 

```{r}

checklist::checklist(

  system.file("examples", package = "checklist")

)

```