list_my_checks: List all checks for an email address

View source: R/list.R

list_my_checksR Documentation

List all checks for an email address

Description

List all checks for an email address

Usage

list_my_checks(email = email_address(), package = NULL, howmany = 20)

Arguments

email

Email address. By default it is guessed with whoami::email_address(). The address must be validated, see validate_email().

package

NULL, or a character scalar. Can be used to restrict the search for a single package.

howmany

How many check groups (checks submitted simultaneously) to show. The current API limit is 20.

Value

A tibble::tibble with columns:

  • package Name of the package.

  • version Package version.

  • result: More detailed result of the check. Can be NULL for errors. This is a list column with members: status, errors, warnings, notes.

  • group: R-hub check group id.

  • id: 'R-hub check id.

  • platform_name: Name of the check platform.

  • build_time: Build time, a difftime object.

  • submitted: Time of submission.

  • started: Time of the check start.

  • platform: Detailed platform data, a list column.

  • builder: Name of the builder machine.

  • status Status of the check. Possible values:

    • created: check job was created, but not running yet.

    • in-progress: check job is running.

    • parseerror: internal R-hub error parsing the check results.

    • preperror: check error, before the package check has started.

    • aborted: aborted by admin or user.

    • error: failed check. (Possibly warnings and notes as well.)

    • warning: R CMD check reported warnings. (Possibly notes as well.)

    • note: R CMD check reported notes.

    • ok: successful check.

  • email: Email address of maintainer / submitter.

See Also

list_package_checks

Examples

## Not run: 
ch <- list_my_checks()
ch
ch$details()

## End(Not run)

rhub documentation built on Aug. 31, 2022, 5:06 p.m.