r - Roxygen2スタイルのドキュメントで「@」をエスケープする

Question

メールアドレスを書きたいコメントブロックがあるとしましょう。roxygenがそれをディレクティブではなくテキストとして扱うように、「@」記号をエスケープするにはどうすればよいですか？

Answer 1

ダブルアットマーク@@がその役割を果たします。

例として、このドキュメントの作成者フィールドの電子メールアドレスを取り上げます。

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

で処理するとこの*.Rdファイルが生成されます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}
}