Learn R Programming

TeXCheckR (version 0.2.0)

report_error: Report errors to console and twitter

Description

Report errors to console and twitter

Usage

report2console(line_no = NULL, context = NULL, error_message = NULL,
  advice = NULL, build_status = NULL, authors = NULL,
  report_name = NULL, extra_cat_ante = NULL, extra_cat_post = NULL)

report2twitter(preamble = NULL, report_name, build_status, error_message, line_no = NULL, context = NULL, authors, extra_cat_ante = NULL, extra_cat_post = NULL, globalEnv = NULL)

report2gmail(preamble = NULL, report_name, build_status, error_message, line_no = NULL, context = NULL, authors, extra_cat_ante = NULL, extra_cat_post = NULL)

Arguments

line_no

The line number locating the source of the error.

context

THe content of the file to provide context to the error.

error_message

The error message to display beyond the console.

advice

Advice to the user: how should the detected error be resolved in general?

build_status

What should the build status be reported as?

authors

Text to alert the authors (such as a twitter handle).

report_name

Name of project whose errors are being reported.

extra_cat_ante

Character vector extra messages (placed before context).

extra_cat_post

Character vector extra messages (placed after context).

preamble

Message to appear before other messages.

globalEnv

The environment in which tweet statuses should be assigned. The default, NULL, is an error. The environment must be set by the user to comply with (reasonable) CRAN requirements to not interfere with the user's environment.