The hardware and bandwidth for this mirror is donated by dogado GmbH, the Webhosting and Full Service-Cloud Provider. Check out our Wordpress Tutorial.
If you wish to report a bug, or if you are interested in having us mirror your free-software or open-source project, please feel free to contact us at mirror[@]dogado.de.

Title: Automatically Search Errors or Warnings
Version: 0.1.2
Description: Provides environment hooks that obtain errors and warnings which occur during the execution of code to automatically search for solutions.
URL: https://github.com/coatless-rpkg/errorist, https://r-pkg.thecoatlessprofessor.com/errorist/
BugReports: https://github.com/coatless-rpkg/errorist/issues
Depends: R (≥ 3.0.0)
Imports: searcher (≥ 0.0.2)
Suggests: testthat, covr, knitr, rmarkdown
License: GPL-2 | GPL-3 [expanded from: GPL (≥ 2)]
Encoding: UTF-8
RoxygenNote: 7.2.3
VignetteBuilder: knitr
NeedsCompilation: no
Packaged: 2023-11-14 02:10:27 UTC; ronin
Author: James Balamuta ORCID iD [aut, cre, cph]
Maintainer: James Balamuta <balamut2@illinois.edu>
Repository: CRAN
Date/Publication: 2023-11-14 06:33:39 UTC

errorist: Automatically Search Errors or Warnings

Description

Provides environment hooks that obtain errors and warnings which occur during the execution of code to automatically search for solutions.

Author(s)

Maintainer: James Balamuta balamut2@illinois.edu (ORCID) [copyright holder]

See Also

Useful links:


Enable or Disable Errorist's Automatic Search

Description

Activates or disengages the automatic look up of error or warning codes in R.

Usage

enable_errorist(
  error_search_func = getOption("errorist.warning", searcher::search_google),
  warning_search_func = getOption("errorist.warning", searcher::search_google)
)

disable_errorist()

Arguments

error_search_func, warning_search_func

The search function from searcher that should be called when an error or warning occurs. By default, searches are routed through Google.

Details

The enable_errorist() is automatically called on package start to inject handlers for warnings and errors. When the package is unloaded, disable_errorist() is called to remove warnings and errors. If you wish to disable warnings or error individually, please use either disable_error_shim() or disable_warning_shim().

Author(s)

James Joseph Balamuta

See Also

enable_error_shim(), enable_warning_shim(), disable_error_shim(), disable_warning_shim()

Examples


### Default search engine is Google

# Enable automatic search
# NB: This is done automatically on package load.
enable_errorist()

# Some code ...

# Disable automatic search
# NB: This is done automatically on package unload via "detach()"
disable_errorist()

#### Custom search engines

# Enable automatic search with custom search engines
# NB: This is done automatically on package load.
enable_errorist(error_search_func   = searcher::search_bing,
                warning_search_func = searcher::search_duckduckgo)

# Some code ...

# Disable automatic search
# NB: This is done automatically on package unload via "detach()"
disable_errorist()

Enable and Disable Warning or Error Capture

Description

Add or remove a listener to top-level task callbacks that checks for whether a new warning or error occurs and then triggers a search browser.

Usage

enable_warning_shim(
  warning_search_func = getOption("errorist.warning", searcher::search_google)
)

disable_warning_shim()

enable_error_shim(
  error_search_func = getOption("errorist.error", searcher::search_google)
)

disable_error_shim()

Arguments

error_search_func, warning_search_func

The search function from searcher that should be called when an error or warning occurs. By default, searches are routed through Google.

Details

By default, both enable_warning_shim() and enable_error_shim() functions are automatically triggered when the errorist package is loaded.

Error Shim

The error shim uses R's default handler for errors set by specifying a function for error in options().

Warning Shim

For the warning shim, a top-level task callback added to the environment via base::addTaskCallback(). This causes the warning handler to fire each time a new function call occurs in R regardless of whether it triggers an error.

Author(s)

James Joseph Balamuta

See Also

base::addTaskCallback()

Examples



# Default setup
enable_warning_shim()

# Some code ...

# Remove the shim
disable_warning_shim()

# Specify a search function
enable_warning_shim(warning_search_func = searcher::search_google)

# Some code ...

# Remove the shim
disable_warning_shim()

# Enable only the error shim
enable_error_shim()

# Some code ...

# Remove the shim
disable_error_shim()

# Specify a search function
enable_error_shim(error_search_func = searcher::search_google)

# Some code ...

# Remove the shim
disable_error_shim()

These binaries (installable software) and packages are in development.
They may not be fully stable and should be used with caution. We make no claims about them.
Health stats visible at Monitor.