cran_incoming: List packages in CRAN incoming queue.
In fmichonneau/foghorn: Summarize CRAN Check Results in the Terminal

View source: R/cran_queue.R

cran_incoming

R Documentation

List packages in CRAN incoming queue.

Description

Check where your package stands in the CRAN incoming queue.

Usage

cran_incoming(
  pkg = NULL,
  folders = cran_incoming_folders(),
  sort_by_date = TRUE
)

cran_incoming_folders(include_archive = FALSE)

Arguments

`pkg`	Optionally provide a vector of package names to limit the results to these packages.
`folders`	Which folders of the CRAN queue do you want to inspect? Default: all the non-human folders.
`sort_by_date`	when `TRUE` (default), the output is sorted in decreasing order according to the submission time.
`include_archive`	when `TRUE`, the function `cran_incoming_folders()` also returns the `archive` folder.

Details

When submitting a package to CRAN, it undergoes a series of checks before it is published and publicly available. cran_incoming() allows you to check the packages that are currently in the queue, and the folder where they are located. This information could help you track your package submission. Only the following folders are considered (approximately in order of the CRAN queue sequence): newbies, inspect, pretest, recheck, pending, waiting, publish. The folder archive is not inspected by default. The folders named after the initials of the CRAN volunteers are not inspected.

Value

cran_incoming() returns tibble with the following columns:

package: package name
version: package version
cran_folder: folder where the package was found
time: date/time package was entered in the folder
size: the size of the package tarball

cran_incoming_folders() returns a character vector of the names of the folders used as part of the CRAN submission process, archive being included optionally.

Note that if the package version is not provided, it will appear as NA in the tibble.

Disclaimer

The information provided here is only to give you an indication of where your package stands in the submission process. It can be useful to confirm that your package has been correctly uploaded to CRAN. Please consult the CRAN Repository Policy if you have any questions.

Note

The meaning of the package folders is as follows (see Hornik, Ligges and Zeileis https://journal.r-project.org/archive/2018-1/cran.pdf and Uwe Ligges mailing list comment https://stat.ethz.ch/pipermail/r-package-devel/2019q1/003631.html):

newbies: for first time submission; package will be manually inspected.
inspect: package is awaiting manual inspection; always happens for first time submissions and for packages with problems that are likely to be false positives
pretest: a human has triggered a new auto-check of the package
recheck: package has passed checks and is waiting for reverse dependency checking
pending: a CRAN team member has to do a closer inspection and needs more time
waiting: CRAN's decision is waiting for a response from the package maintainer, e.g. when issues are present that CRAN cannot check for in the incoming checks
publish: package is awaiting publication
archive: package rejected: it does not pass the checks cleanly and the problems are unlikely to be false positives

References

Hornik, Ligges and Zeileis. "Changes on CRAN: 2017-12-01 to 2018-06-30", R Journal 10(1), July 2018. https://journal.r-project.org/archive/2018-1/cran.pdf
Maëlle Salmon, Locke Data, Stephanie Locke, Mitchell O'Hara-Wild, Hugo Gruson. "CRAN incoming dashboard", https://lockedata.github.io/cransays/articles/dashboard.html

Examples

## Not run: 
  ## all the packages in the CRAN incoming queue
  cran_incoming()
  ## to include all the folders including `archive`
  cran_incoming(folders = cran_incoming_folders(include_archive = TRUE)
  ## to only include a folder, e.g., `inspect`
  cran_incoming(folders = "inspect")
  ## if the package `foo` is in the queue, it will appear below
  cran_incoming(pkg = "foo")

## End(Not run)

fmichonneau/foghorn documentation built on Feb. 22, 2024, 1:38 a.m.