example - roxygen2 documentation data

Escape “@” en la documentación del estilo Roxygen2

Question

Digamos que tengo un bloque de comentarios donde me gustaría escribir una dirección de correo electrónico. ¿Cómo haría para escapar del símbolo "@" para que Roxygen lo trate como texto en lugar de una directiva?

Answer 1

Un doble en el signo @@ hará el trabajo.

Como ejemplo, tome la dirección de correo electrónico en el campo de autor de esta documentación:

##'' A package to check Roxygen''s sanity.
##'' @name helloRoxygen-package
##'' @docType package
##'' @author My name /email{me@@here.org}
NA

que produce este archivo *.Rd cuando se procesa con roxygenize() :

/docType{package}
/name{helloRoxygen-package}
/alias{helloRoxygen-package}
/title{A package to check Roxygen''s sanity.}
/description{
A package to check Roxygen''s sanity.
}
/author{
My name /email{[email protected]}
}