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}
}