Digamos que tengo un bloque de comentarios donde me gustaría escribir una dirección de correo electrónico. ¿Cómo podría escapar al símbolo "@" para que roxygen lo trate como texto en lugar de una directiva?Escapar "@" en Roxygen2 Style Documentation
Un doble en el signo @@ hará el trabajo.
A modo de ejemplo, tomar 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{[email protected]@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]}
}
doble arco iris? ;) –
Sea amable al tener en cuenta cómo se manejan @ símbolos al acceder a las ranuras en el código @example. – tim
@tim - ¿Cómo se manejan? ¿Requieren un tratamiento especial o los autores de roxygen solo permiten que el código de ejemplo se transmita textualmente? –