Flucht "@" in der Dokumentation im Roxygen2 -Stil -Stil
Frage
Nehmen wir an, ich habe einen Kommentarblock, in dem ich eine E -Mail -Adresse schreiben möchte. Wie würde ich vor dem Entkommen des "@" -Symbols gehen, also behandelt Roxygen es als Text anstelle einer Richtlinie?
Lösung
Ein doppeltes At-Sign @@
wird den Job machen.
Nehmen Sie als Beispiel die E -Mail -Adresse im Feld Autor dieser Dokumentation:
##' A package to check Roxygen's sanity.
##' @name helloRoxygen-package
##' @docType package
##' @author My name \email{me@@here.org}
NA
das produziert das *.Rd
Datei bei verarbeitet mit 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}
}
Lizenziert unter: CC-BY-SA mit Zuschreibung
Nicht verbunden mit StackOverflow