Я занимаюсь документированием некоторых моих функций для пакета R, который я создаю.

Я использую разметку roxygen, хотя это в значительной степени не имеет отношения к моему вопросу.

Я разместил уравнения в своей документации, используя \deqn{...}. Мой вопрос: Есть ли способ перекрестного ссылки на это уравнение позже?

Например, в моем Rd файле:

\deqn{\label{test}
 y = mx + b
}

Могу ли я позже сделать что-то вроде:

Ссылаясь на уравнение \ref {test},...

Я пробовал \eqref{test}, \ref{test} (которые оба получают "неизвестный макрос" и не связаны), а также \link{test} (который жалуется, что не может найти функцию test, потому что это действительно просто для привязки к другим функциям).

В противном случае я боюсь, что мне, возможно, придется что-то взломать и добавить в -- (1) и Refer to equation (1) вручную в \deqn и т.д. в файле Rd...

Update

Общий ответ выглядит как "нет". (Awww...)

Однако я могу написать виньетку и использовать там "нормальный" латекс/пакеты. В любом случае, я только что заметил, что матричные уравнения, которые я потратил на перенос в мой файл roxygen/Rd, выглядят ужасно в версии справки ?myFunction (они отображаются как буквально буквальный источник латекса). Какой позор, потому что они выглядят красиво в pdf-версии справки.

@Iterator указал на существование условного текста, поэтому я буду делать математику ASCII в файлах .Rd, но математика Latex в pdf-руководство/виньетка.

Ответ 1

Я компилирую свои комментарии выше в ответ, для других.

Во-первых, я действительно не знаю, поддерживает или нет .Rd поддерживает тегирование уравнений. Тем не менее, формат .Rd является таким строгим подмножеством LaTeX и дает очень примитивный вывод текста, что shoehorning обширные уравнения в его формат может быть болезненным делом без особых преимуществ для пользователя.

Альтернативой является использование виньет пакетов или даже внешняя размещенная документация (как это делает Хэдли Викхем для некоторых своих пакетов). Это позволит вам использовать PDF файлы или другую документацию для вашего сердца. Таким образом, вы можете включать скриншоты, сюжеты, все самые забавные расширения LaTeX, которые есть только у вас, и, самое главное, расширения AMS, которые все мы знаем и любим.

Тем не менее, можно указать различный рендеринг данного раздела документации (в .Rd) на основе интерфейса, например текст для консоли, приятные символы для HTML и т.д., и условный текст поддерживает такое изменение формата.

Это хороший вопрос. Я не знаю ответа на вопрос о целесообразности, но у меня были схожие вопросы о документировании функций и уравнений вместе, и это исследование того, что возможно с файлами .Rd, убеждало меня использовать PDF-виньетки, а не файлы .Rd.