R/chk_covr.R

In goodpractice: Advice on R Package Building

#' @include lists.R customization.R

CHECKS$covr <- make_check(

  description = "All code is unit tested",
  tags = c("warning", "code coverage", "covr"),
  preps = "covr",

  gp = function(state) {
    percent <- state$covr$pct_by_line
    paste0(
      "write unit tests for all functions, and all package code in ",
      "general. ", trunc(percent), "% of code lines are covered by ",
      "test cases."
    )
  },

  check = function(state) {
    if(inherits(state$covr, "try-error"))
      return(list(status = NA, positions = list()))
    
    zero <- state$covr$zero
    if (NROW(zero) == 0) return(list(status = TRUE, positions = list()))
    
    positions <- lapply(seq_len(NROW(zero)), function(i) {
      list(
        filename = zero$filename[i],
        line_number = zero$line[i],
        column_number = NA_integer_,
        ranges = list(),
        line = NA_character_
      )
    })
    
    list(status = FALSE, positions = positions)
  }
)