Escapar de "@" en la documentación de estilo Roxygen2

Question

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

Answer 1

Un doble firma en @@ hará el trabajo.

Como ejemplo, tome la dirección de correo electrónico en el campo del 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 esto *.Rd Archivo cuando se procese 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{me@here.org}
}