checker_options: Checker Options

Description Usage Arguments Details Value Examples

View source: R/checker_options.R

Description

Checker Options

Usage

1

Arguments

checker_options

a named list of the checker options to customize.

...

ignored for now

Details

Customize which HTTP status codes and other situations lead checker to mark links and other URIs as problematic.

Each options can take one of 4 values: - "ok": silently ignored situation - "message": message-level notification that the situation was encountered - "warning": warning-level notification - "error": error-level notification.

For instance, you will most likely always want 'status_code_404 = "error"', so checker will report as invalid 404 HTTP status codes.

You can customize default values by:

* specifying options in your '.Rprofile'

* passing a list of the options you want to customize to 'check_links()' using the 'checker_options' argument

Value

a customized list of checker options

Examples

1
## check_links(..., checker_options = list(status_code_300 = "ok", status_code_301 = "warning"))

fmichonneau/checker documentation built on July 3, 2020, 3:13 a.m.