Уравнения в r пакетной документации не работают - PullRequest
0 голосов
/ 05 марта 2019

Я использую roxygen2 для описания своего пакета и хочу, чтобы в моей документации были математические уравнения.Например, я хочу написать n_ {u} как формула.Когда я пишу \ eqn {n_ {u}} в @details, ничего не происходит, но текст курсивом.Я документирую пакет с помощью control, shift и d, а затем нажимаю «Очистить и восстановить».Я что-то забыл?

Ответы [ 2 ]

0 голосов
/ 05 марта 2019

\eqn{n_u} для документации в формате PDF.

Напишите это вместо:

\ifelse{html}{\out{n<sub>u</sub>}{\eqn{n_u}}

Синтаксис:

\ifelse{html}{\out{HTML CODE}}{\eqn{LATEX-LIKE CODE}{ASCII}}

с {ASCII} необязательно:для текстовой документации.HTML CODE для документации в формате HTML, LATEX-LIKE CODE для документации в формате PDF.

0 голосов
/ 05 марта 2019

Это ожидаемое поведение.Формат документации R не имеет «реальных» уравнений, как вы могли бы получить от Mathjax или другого полноценного движка Latex;он использует базовое представление, которое просто копирует текст вашего уравнения, но выделяет его курсивом.Считайте, что это больше похоже на код, чем на математическую нотацию.

...