Skip to contents

Files a support ticket from your R session. The report reaches the same place as one filed through the support site, and you get back a link to follow.

You supply what only you can: the code that went wrong and what you expected it to do. Everything else – which R version, which packages were loaded, who you are and which project you are working in – is filled in for you.

Usage

report_bug(
  reprex,
  expected,
  severity = c("blocks-work", "degraded", "cosmetic"),
  package = NULL,
  summary = NULL
)

Arguments

reprex

Character. The code that goes wrong, as short as you can make it while still failing. Paste the error message too.

expected

Character. What you expected to happen instead.

severity

One of "blocks-work" (you cannot carry on), "degraded" (there is a workaround), or "cosmetic".

package

Character. The package the bug is in. Defaults to the package calling report_bug(), which is only useful from inside package code – from the console, name it.

summary

Character. An optional one-line title. Without it the title is drawn from the report itself.

Value

The URL of the filed issue, invisibly.

Examples

if (FALSE) { # \dontrun{
report_bug(
  package = "spdgt.telem",
  reprex = "telem_get_deployments(individual_id = 12)\n#> Error: ...",
  expected = "a tibble of deployments for that individual",
  severity = "blocks-work"
)
} # }