Comment croiser une équation dans un fichier d'aide R / roxygen2

Question

Je suis en train de documenter certaines de mes fonctions pour un package R que je fais.

J'utilise le balisage de Roxygen, bien que cela ne soit largement pas pertinent pour ma question.

J'ai mis des équations dans ma documentation en utilisant \deqn{...}. Ma question est:Existe-t-il un moyen de référencer cette équation plus tard?

Par exemple, dans mon fichier RD:

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

Puis-je faire plus tard quelque chose comme:

Se référant à l'équation ref {test}, ...

J'ai essayé \eqref{test}, \ref{test} (qui sont à la fois "macro inconnus" et ne sont pas liés), et aussi \link{test} (qui se plaint qu'il ne trouve pas de fonction test Parce que c'est vraiment juste pour être lié à d'autres fonctions).

Sinon, je crains de devoir faire quelque chose de piratage et d'ajouter -- (1) et Refer to equation (1) manuellement dans \deqn etc dans le fichier RD ...

Mise à jour

La réponse générale semble être "non". (awww ...)

Cependant, je peux écrire une vignette et y utiliser des latex / packages "normaux". Dans tous les cas, je viens de remarquer que les équations matricielles que j'ai dépensées à l'âge dans mon fichier Roxygen / RD semblent horribles dans le ?myFunction Version de l'aide (ils apparaissent comme une source de latex littérale juste. Ce qui est dommage, car ils sont beaux dans la version PDF de l'aide.

@Iterator a souligné l'existence de texte conditionnel, Je vais donc faire des mathématiques ASCII dans les fichiers .rd, mais les mathématiques de latex dans le manuel / vignette PDF.

Answer 1

Je compile mes commentaires ci-dessus dans une réponse, au profit des autres.

Tout d'abord, je ne sais pas réellement si .rd prend en charge le taggage des équations. Cependant, le format .rd est un sous-ensemble si strict de latex, et produit une sortie de texte très primitive, que les équations étendues de chaussure dans son format pourraient être une entreprise douloureuse sans beaucoup de bénéfice pour l'utilisateur.

L'alternative est d'utiliser vignettes de package, ou même la documentation hébergée en externe (comme cela est fait par Hadley Wickham, pour certains de ses forfaits). Cela vous permettra d'utiliser des PDF ou une autre documentation, pour le contenu de votre cœur. De cette façon, vous pouvez inclure des captures d'écran, des intrigues, toutes les extensions de latex les plus funkes que vous seul avez et, surtout, les extensions AMS que nous connaissons et aimons tous.

Néanmoins, on peut spécifier un rendu différent d'une section donnée de documentation (dans .rd) en fonction de l'interface, telle que du texte pour la console, de beaux caractères pour HTML, etc., et texte conditionnel prend en charge ce type de variation de format.

C'est une bonne question. Je ne connais pas la réponse concernant la faisabilité, mais j'avais des questions similaires sur la documentation des fonctions et des équations ensemble, et cette enquête sur ce qui est possible avec les fichiers .rd m'a convaincu d'utiliser des vignettes PDF plutôt que des fichiers .rd.