Получите сообщения об ошибках от R, отображаемые как они изначально появляются в сеансе R с использованием knitr - PullRequest
0 голосов
/ 10 сентября 2018

Я хотел бы создать HTML-документ, используя Rmarkdown, в котором сообщения об ошибках от R могут отображаться так, как они изначально появляются в интерактивном сеансе R.

Этот вопрос аналогичен, но не требует, чтобы сообщения об ошибках отображались точно так же, как в интерактивном сеансе: я пытался использовать error=TRUE для данного чанка, при ошибке добавляется префикс Error in eval(expr, envir, enclos):

Со следующим фрагментом:

```{r, error=TRUE}
notexistingvariable
```

Я ожидаю:

Error: object 'notexistingvariable' not found

Я получаю:

Error in eval(expr, envir, enclos): object 'notexistingvariable' not found

Я попытался добавить опцию results="asis", но здесь это никак не отразилось. Я думаю, что это относится только к выводу без ошибок.


Попытка использования wrap.error

Как предлагалось в ответах , я попытался установить пользовательскую функцию wrap.error.

test.Rmd

---
title: "test"
output: html_document
---

```{r setup, include=FALSE}
knitr::opts_chunk$set(echo = TRUE)

wrap.error <- function(x, options) {
  # x is an error object, with components "call" and "message".  Ignore
  # the call, but wrap the result like code:
  paste0("```\n## Error: ", x$message, "\n```")
}
```

```{r, error=TRUE}
notexistingvariable
```

Преобразование в html:

$ R -e "rmarkdown::render('test.Rmd',output_file='test.html')"

R version 3.5.1 (2018-07-02) -- "Feather Spray"
Copyright (C) 2018 The R Foundation for Statistical Computing
Platform: x86_64-pc-linux-gnu (64-bit)

R is free software and comes with ABSOLUTELY NO WARRANTY.
You are welcome to redistribute it under certain conditions.
Type 'license()' or 'licence()' for distribution details.

R is a collaborative project with many contributors.
Type 'contributors()' for more information and
'citation()' on how to cite R or R packages in publications.

Type 'demo()' for some demos, 'help()' for on-line help, or
'help.start()' for an HTML browser interface to help.
Type 'q()' to quit R.

> rmarkdown::render('test.Rmd',output_file='test.html')


processing file: test.Rmd
  |................                                                 |  25%
  ordinary text without R code

  |................................                                 |  50%
label: setup (with options) 
List of 1
 $ include: logi FALSE

  |.................................................                |  75%
  ordinary text without R code

  |.................................................................| 100%
label: unnamed-chunk-1 (with options) 
List of 1
 $ error: logi TRUE


output file: test.knit.md

/usr/bin/pandoc +RTS -K512m -RTS test.utf8.md --to html4 --from markdown+autolink_bare_uris+ascii_identifiers+tex_math_single_backslash --output test.html --smart --email-obfuscation none --self-contained --standalone --section-divs --template /home/bli/R/x86_64-pc-linux-gnu-library/3.5/rmarkdown/rmd/h/default.html --no-highlight --variable highlightjs=1 --variable 'theme:bootstrap' --include-in-header /tmp/RtmpAoBtc7/rmarkdown-str53186fa5c04d.html --mathjax --variable 'mathjax-url:https://mathjax.rstudio.com/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML' 

Output created: test.html
> 
> 

Файл test.html выглядит следующим образом:

html rendering by firefox


Использование wrap.simpleError, как предлагает обновленный ответ, работает.

1 Ответ

0 голосов
/ 10 сентября 2018

(Обновлено, чтобы отразить изменения в R 3.5.x)

Вы можете установить пользовательские средства визуализации для вывода (см. vignette("knit_print")), но я думаю, что они не вызываются при возникновении ошибки. В этом случае вызывается общая функция wrap(). knitr определяет метод wrap.error(), и до R 3.5.0 он мог быть переопределен пользователем. Однако в последней версии R методы, определенные в пакете, выбираются предпочтительнее методов, определенных пользователем, поэтому он больше не работает.

Тем не менее, есть еще решение для некоторых ошибок. Для примера в вопросе созданный объект ошибки имеет класс c("simpleError", "error", "condition"), а knitr не определяет метод wrap.simpleError(). Вы можете определить один и переопределить его обработку.

Вы делаете это так:

```{r setup, include=FALSE}
knitr::opts_chunk$set(echo = TRUE)

wrap.simpleError <- function(x, options) {
  # x is an error object, with components "call" and "message".  Ignore
  # the call, but wrap the result like code:
  paste0("```\n## Error: ", x$message, "\n```")
}
```

```{r, error=TRUE}
notexistingvariable
```

Это отображает результат следующим образом: enter image description here

Существует также выходной хук для обработки ошибок: см. https://yihui.name/knitr/hooks/. Однако он, кажется, вызывается после wrap.error, когда сообщение уже сформировано. Вы можете редактировать это сообщение, чтобы удалить части, которые вы не хотите использовать, как этот код:

```{r}   
knitr::knit_hooks$set(error = function(x, options) {
  paste0("```\n", 
         sub(" in eval(expr, envir, enclos)", "", x, fixed = TRUE),
         "\n```")
})
```e

Это может быть более надежным, чем wrap.simpleError подход, который перестанет работать, если knitr когда-либо определит такой метод wrap.simpleError. Он также будет обрабатывать все ошибки, а не только "simpleError". Имеет недостаток в том, что его, вероятно, сложнее настроить для обработки разных типов ошибок, и он может не работать в разных локалях, где «Ошибка в» переводится на другой язык.

...