r - Escaping "@" in Roxygen2 Style Documentation

Question

Let's say I have a comment block where I'd like to write an email address. How would I go about escaping the "@" symbol so roxygen treats it as text instead of a directive?

Answer 1

A double at-sign @@ will do the job.

As an example, take the email address in the author field of this documentation:

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

which produces this *.Rd file when processed with roxygenize():

docType{package}

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