R/check-renv.R

In ropenscilabs/pkgcheck: rOpenSci Package Checks

#' For packages which use 'renv', check that it is de-activated.
#'
#' Although we do not generally recommend 'renv' for package developement,
#' packages may use it. They must, however, ensure that [`renv` is
#' deactivated](https://rstudio.github.io/renv/reference/deactivate.html).
#'
#' @param checks A 'pkgcheck' object with full \pkg{pkgstats} summary and
#' \pkg{goodpractice} results.
#' @return TRUE if `renv` is used; otherwise FALSE
#' @noRd
pkgchk_renv_activated <- function (checks) {

    return (checks$info$renv_activated)
}

output_pkgchk_renv_activated <- function (checks) {

    out <- list (
        check_pass = !checks$checks$renv_activated,
        summary = "",
        print = ""
    )

    if (!out$check_pass) {
        out$summary <- "Package has renv activated"
    }

    return (out)
}