Скажем, у меня есть блок комментариев, где я бы хотел написать адрес электронной почты. Как бы я пошел по экрану символа "@", поэтому roxygen рассматривает его как текст вместо директивы?
Экранирование "@" в Roxygen2 Style Documentation
Ответ 1
Двойной знак at @@ выполнит эту работу.
В качестве примера возьмите адрес электронной почты в поле автора этой документации:
##' A package to check Roxygen sanity.
##' @name helloRoxygen-package
##' @docType package
##' @author My name \email{[email protected]@here.org}
NA
который создает этот *.Rd файл при обработке с помощью roxygenize():
\docType{package}
\name{helloRoxygen-package}
\alias{helloRoxygen-package}
\title{A package to check Roxygen sanity.}
\description{
A package to check Roxygen sanity.
}
\author{
My name \email{[email protected]}
}