Trying out using precommit for precommit hooks

Author: Sarah Endicott

.Rbuildignore

@@ -1,21 +1,21 @@
-^data-raw$
-^extraPackageInstalls.R$
-^installRoads.R$
-^kylesCLUSExample.Rmd$
-^projectRoadsTroutLakeExample.R$
 ^.*\.Rproj$
-^\.Rproj\.user$
+^CRAN-RELEASE$
+^CRAN-SUBMISSION$
+^LICENSE\.md$
 ^README\.Rmd$
+^\.Rproj\.user$
+^\.git$
 ^\.github$
-^cran-comments\.md$
-^LICENSE\.md$
+^\.pre-commit-config\.yaml$
 ^_pkgdown\.yml$
+^cran-comments\.md$
+^data-raw$
 ^docs$
+^extraPackageInstalls.R$
+^installRoads.R$
+^kylesCLUSExample.Rmd$
 ^pkgdown$
-^vignettes/articles$
-^\.git$
-^tests/testthat/benchmarking.R
-^CRAN-RELEASE$
-
-^CRAN-SUBMISSION$
+^projectRoadsTroutLakeExample.R$
 ^revdep$
+^tests/testthat/benchmarking.R
+^vignettes/articles$

.pre-commit-config.yaml

@@ -0,0 +1,56 @@
+# All available hooks: https://pre-commit.com/hooks.html
+# R specific hooks: https://github.com/lorenzwalthert/precommit
+repos:
+-   repo: https://github.com/lorenzwalthert/precommit
+    rev: v0.4.3.9030
+    hooks:   
+    -   id: roxygenize
+        # roxygen requires loading pkg -> add dependencies from DESCRIPTION
+        additional_dependencies:
+        -    dplyr
+        -    igraph
+        -    data.table
+        -    sf
+        -    units
+        -    rlang
+        -    methods
+        -    tidyselect
+        -    terra
+    -   id: use-tidy-description
+    -   id: spell-check
+        exclude: >
+          (?x)^(
+          .*\.[rR]|
+          .*\.feather|
+          .*\.jpeg|
+          .*\.pdf|
+          .*\.png|
+          .*\.py|
+          .*\.RData|
+          .*\.rds|
+          .*\.Rds|
+          .*\.Rproj|
+          .*\.sh|
+          (.*/|)\.gitignore|
+          (.*/|)\.gitlab-ci\.yml|
+          (.*/|)\.lintr|
+          (.*/|)\.pre-commit-.*|
+          (.*/|)\.Rbuildignore|
+          (.*/|)\.Renviron|
+          (.*/|)\.Rprofile|
+          (.*/|)\.travis\.yml|
+          (.*/|)appveyor\.yml|
+          (.*/|)NAMESPACE|
+          (.*/|)renv/settings\.dcf|
+          (.*/|)renv\.lock|
+          (.*/|)WORDLIST|
+          \.github/workflows/.*|
+          data/.*|
+          )$
+    -   id: readme-rmd-rendered
+    -   id: parsable-R
+    -   id: no-browser-statement
+    -   id: no-print-statement
+    -   id: no-debug-statement
+    -   id: deps-in-desc
+    -   id: pkgdown

DESCRIPTION

@@ -49,7 +49,6 @@ Imports:
     methods,
     tidyselect,
     terra
-RoxygenNote: 7.3.3
 Suggests: 
     testthat (>= 2.1.0),
     knitr,
@@ -82,3 +81,4 @@ Collate:
     'dem_example.R'
 BugReports: https://github.com/LandSciTech/roads/issues
 Roxygen: list(markdown = TRUE)
+Config/roxygen2/version: 8.0.0

R/getDistFromSource.R

@@ -62,7 +62,7 @@
 #'  library(sf)
 #'  library(terra)
 #'
-#' #make example roads from scratch
+#' # make example roads from scratch
 #' rds <- st_as_sf(data.frame(x = 1:1000/100, y = cos(1:1000/100)),
 #'                 coords = c("x", "y"))
 #' rds <- st_cast(st_union(rds), "LINESTRING")

inst/WORDLIST

@@ -0,0 +1,61 @@
+artefacts
+aut
+bc
+BugReports
+buildSimList
+buildSnapRoads
+CLUSexample
+Config
+cph
+cre
+CRS
+dem
+demoScen
+disaggregated
+dplyr
+ec
+endicott
+Endicott
+gc
+gdistance
+getClosestRoad
+getDistFromSource
+getGraph
+getLandingsFromTarget
+github
+https
+hughes
+igraph
+io
+josie
+knitr
+landscitech
+LandSciTech
+LazyData
+lcpList
+Lochhead
+modelling
+mstList
+ORCID
+pathsToLines
+pfocal
+plotRoads
+prepExData
+projectRoads
+rasterizeLine
+RasterLayer
+rasters
+rasterToLineSegments
+rlang
+rmarkdown
+roxygen
+Roxygen
+sarah
+shortestPaths
+SpatRaster
+terra
+testthat
+tidyselect
+VignetteBuilder
+viridis
+weightFunctions