Come riferimento incrociato un'equazione in un file di aiuto R/roxygen2

Question

Sono in procinto di documentare alcune delle mie funzioni per un pacchetto R che sto facendo.

Uso il markup del roxygen, sebbene ciò sia in gran parte irrilevante per la mia domanda.

Ho messo equazioni nella mia documentazione usando \deqn{...}. La mia domanda è: C'è un modo per fare un riferimento incrociato a questa equazione in seguito?

Per esempio, nel mio file Rd:

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

Posso poi fare qualcosa di simile:

riferimento all'equazione \ ref {test}, ...

ho provato \eqref{test}, \ref{test} (che sia ottenere "macro sconosciuto" e non farsi linked), e anche \link{test} (che comp non può trovare la funzione test perché è davvero solo per il collegamento ad altre funzioni).

altrimenti temo che possa avere a che fare qualcosa di hacky e aggiungere nella risposta generale -- (1) e Refer to equation (1)manualmente all'interno della \deqn etc nel file Rd ...

Aggiornamento

sembra essere " no". (awww ...)

Tuttavia, posso scrivere una vignetta e utilizzare "normali" latex/pacchetti lì. In ogni caso, ho appena notato che le equazioni matriciali che ho passato invecchiando nel mio file roxygen/Rd appaiono orribili nella versione ?myFunction dell'aiuto (si presentano come fonti letterali di lattice di tipo just-about). Il che è un peccato, perché sono belli nella versione pdf dell'aiuto.

@Iterator ha sottolineato l'esistenza di conditional text, quindi dovrò fare la matematica ASCII nei file .rd, ma la matematica lattice nel pdf manuale/vignetta.

Answer 1

Sto compilando i miei commenti sopra in una risposta, per il bene degli altri.

In primo luogo, in realtà non so se .Rd supporta o meno la codifica delle equazioni. Tuttavia, il formato .Rd è un sottoinsieme così ristretto di LaTeX e produce un output di testo molto primitivo, che risolvendo le equazioni estese nel suo formato potrebbe essere un'impresa dolorosa senza troppi benefici per l'utente.

L'alternativa è quella di utilizzare package vignettes, o anche la documentazione ospitato esternamente (come è fatto da Hadley Wickham, per alcuni dei suoi pacchetti). Ciò ti consentirà di utilizzare PDF o altra documentazione, a tuo piacimento. In questo modo, puoi includere screenshot, grafici, tutte le estensioni LaTeX più divertenti che hai solo tu e, soprattutto, le estensioni AMS che tutti conosciamo e amiamo.

Tuttavia, è possibile specificare il rendering diverso di una determinata sezione di documentazione (in .Rd) in base all'interfaccia, ad esempio testo per la console, caratteri carini per HTML, ecc. E supporta questo tipo di variazione di formato .

È una buona domanda.Non conosco la risposta relativa alla fattibilità, ma ho avuto domande simili sulla documentazione di funzioni ed equazioni insieme, e questa ricerca su ciò che è fattibile con i file .Rd mi ha convinto a usare vignette PDF piuttosto che file .Rd.