argel-tal/nzpoliceutilities

Helper R package to assist the design of R products for New Zealand Police's National Road Policing Centre (NRPC).

NZPoliceUtilities

Helper R package to assist the design of R products for New Zealand Police's (NZP) National Road Policing Centre (NRPC).

Will contain useful functions and non-private data for quick reference and auto-formatting, i.e.

• loading the approved NZP colours as an R theme, for use in graphing
• pulling in and pushing out files from arbitrary paths, read from elsewhere and stored in env instead of as plaintext in codebase
  • means that file path and/or file doesnt need to be written inside the code

This is NOT to be used to store filepaths, actual files or data on NZP processes/people.

To load this package in R:

1. Install the required packages for loading non-CRAN packages
2. Load this package

install.packages("devtools") # only have to do this if `devtools` has never been installed before
install.packages("stringr") # only have to do this if `stringr` has never been installed before
devtools::install_github("Argel-Tal/NZPoliceUtilities")

To see the full list of exported functions:

library("NZPoliceUtilities")
ls("package:NZPoliceUtilities")

WFH to do

• Convert this to binaries so it can be loaded without Rtools 🙄😠

Credits

Author(s):

Jack MacCormick

• Phone: [phone]
• Email: [email protected]

Style attributions:

Fong Chun Chan

• How to make R packages: blog post
  • https://tinyheero.github.io/jekyll/update/2015/07/26/making-your-first-R-package.html
• README design: R package tinyutils
  • https://github.com/tinyheero/tinyutils

nzpoliceutilities's Issues

- [ ] recompile package file

needs to have explicit calls to stringr added into compiled version

Boolean operators to be excluded from unspaced op check

may want to exclude == from the count and list of un-spaced operators

Originally posted by @Argel-Tal in #1 (comment)

Need to scan assignment and equality testing for un-spaced operations

• a==b needs to come back as 2 un-spaced operators. Currently unchecked for
• var=x needs to come back as 1 un-spaced operator. Currently unchecked for

Should be recommending a == b & var = x

TO DO:

1. Replace

  countOperatorNoSpace <- length(setdiff(stringr::str_extract_all(codeRaw, "[\\+\\-\\*].")[[1]], 
                                         unlist(stringr::str_match_all(str_extract_all(codeRaw, "[\\+\\-\\*].")[[1]], ". "))))
  listOperatorNoSpace <- setdiff(stringr::str_extract_all(codeRaw, "[\\+\\-\\*].")[[1]], 
                                 unlist(stringr::str_match_all(stringr::str_extract_all(codeRaw, "[\\+\\-\\*].")[[1]], ". ")))
  
  countOperatorNoSpace1 <- length(setdiff(stringr::str_extract_all(codeRaw, ".[\\+\\-\\*]")[[1]], 
                                         unlist(stringr::str_match_all(str_extract_all(codeRaw, ".[\\+\\-\\*]")[[1]], " ."))))
  listOperatorNoSpace1 <- setdiff(stringr::str_extract_all(codeRaw, ".[\\+\\-\\*]")[[1]], 
                                 unlist(stringr::str_match_all(stringr::str_extract_all(codeRaw, ".[\\+\\-\\*]")[[1]], " .")))

with

  countOperatorNoSpace <- length(setdiff(stringr::str_extract_all(codeRaw, "[\\+\\-\\*\\=].")[[1]], 
                                         unlist(stringr::str_match_all(str_extract_all(codeRaw, "[\\+\\-\\*\\=].")[[1]], ". "))))
  listOperatorNoSpace <- setdiff(stringr::str_extract_all(codeRaw, "[\\+\\-\\*\\=].")[[1]], 
                                 unlist(stringr::str_match_all(stringr::str_extract_all(codeRaw, "[\\+\\-\\*\\=].")[[1]], ". ")))
  
  countOperatorNoSpace1 <- length(setdiff(stringr::str_extract_all(codeRaw, ".[\\+\\-\\*\\=]")[[1]], 
                                         unlist(stringr::str_match_all(str_extract_all(codeRaw, ".[\\+\\-\\*\\=]")[[1]], " ."))))
  listOperatorNoSpace1 <- setdiff(stringr::str_extract_all(codeRaw, ".[\\+\\-\\*\\=]")[[1]], 
                                 unlist(stringr::str_match_all(stringr::str_extract_all(codeRaw, ".[\\+\\-\\*\\=]")[[1]], " .")))

2. Recompile and re-upload package

filePathedToRead() is redundant

Does the same as file.path, which is baked in
lel 😆 🙃

https://github.com/Argel-Tal/NZPoliceUtilities/blob/main/R/filePullPush.R

filePathedToRead <- function(filePathIn, fileName){
  return(stringr::str_c(filePathIn, "/", fileName))
} # end filePathedToRead

• Replace all instances in existing written code