provide_cran_comments {packager}

Provide a Template for Your Comments To CRAN

Description

submit reads a file ‘cran-comments.md’. This function provides a template based on your R version, your R CMD check output and the package's ‘NEWS.md’.

Usage

provide_cran_comments(
  check_log = NULL,
  path = ".",
  initial = FALSE,
  write_to_file = TRUE,
  private_token = NULL,
  name = NA,
  proxy = NULL
)

Arguments

check_log

Deprecated, will be removed in a future release. The local R CMD check log is now supposed to live be 'log/check.(log|Rout)'.

path

Path to the package directory (see devtools::as.package).

initial

Is this an initial submission?

write_to_file

Do write the comment to ‘cran-comment.md’?

private_token

Provide a private token to access https://about.gitlab.com.

name

The name to sign with, if NA, the given name of the package maintainer as stated in file DESCRIPTION is used.

proxy

A proxy to use.

Value

Character vector containing the CRAN comments, which are written to ‘cran-comments.md’ (see Note).

Note

By default this function writes to disk as side effect.

Examples

## Not run: 

if (Sys.info()[["nodename"]] == "fvafrdebianCU") {
    gitlab_token <- readLines(file.path("~", ".gitlab_private_token.txt"))
    proxy <- httr::use_proxy("10.127.255.17", 8080)
    comments <- provide_cran_comments(path = ".",
                                      write_to_file = TRUE,
                                      private_token = gitlab_token,
                                      proxy = proxy)

} else {
    gitlab_token <- readLines(file.path("~", ".gitlab_private_token.txt"))
    comments <- provide_cran_comments(path = ".",
                                      write_to_file = TRUE,
                                      private_token = gitlab_token)
}
cat(comments, sep = "")

## End(Not run)