start spell checks

DESCRIPTION

@@ -29,10 +29,11 @@ Imports:
  sf,
  magrittr
 Suggests: 
-  testthat, 
-  knitr, 
-  rmarkdown,
-  rnaturalearthdata
+    testthat,
+    knitr,
+    rmarkdown,
+    rnaturalearthdata,
+    spelling
 RoxygenNote: 7.2.3
 Collate: 
     'classes.R'

R/plot.R

@@ -14,8 +14,8 @@
 #' created when loading \code{geoGraph}. Users should not have to interact
 #' directly with objects in this environment.\cr
 #'
-#' The resulting plotting behaviour is that when plotting a \code{gGraph}
-#' object, last plotting parameters are re-used. To override this behaviour,
+#' The resulting plotting behavior is that when plotting a \code{gGraph}
+#' object, last plotting parameters are re-used. To override this behavior,
 #' specify \code{reset=TRUE} as argument to \code{plot}.
 #'
 #' @name plot-gGraph

data-raw/submitting_to_cran.R

@@ -0,0 +1,27 @@
+# to this in the dev branch to make sure that all the fundamental issues have been resolved
+# run the spell checking
+usethis::use_spell_check(lang = "en-US")
+
+# check the links
+urlchecker::url_check()
+
+# enhanced local checks
+devtools::check(remote = TRUE, manual = TRUE)
+
+source("./data-raw/helper_functions/check_returns_in_documentation.R")
+
+# now create a cran_submission branch for the final remote tests
+
+# TO DO MANUALLY: update cran-comments.md accordingly
+# update version number
+# update news
+
+# first check with rhub
+package_checks <- rhub::check_for_cran()
+
+# check on macos and windows via devtools
+devtools::check_mac_release()
+devtools::check_win_devel()
+
+# TO DO MANUALLY: if everything passes, edit the cran-comments.md to explain any notes
+devtools::release()

tests/spelling.R

@@ -0,0 +1,3 @@
+if(requireNamespace('spelling', quietly = TRUE))
+  spelling::spell_check_test(vignettes = TRUE, error = FALSE,
+                             skip_on_cran = TRUE)