2012-08-14 17 views
2

我想記錄R中的替代功能,但是當我運行[R CMD檢查我收到此錯誤消息時:<轉義bksl> S4method錯誤記錄的替代功能

Bad \usage lines found in documentation object 'timestamps': 
    <unescaped bksl>S4method{"timestamps<-"}{.MoveTrack}(this, value) 

Functions with \usage entries need to have the appropriate \alias 
entries, and all their arguments documented. 
The \usage entries must correspond to syntactically valid R code. 

的文件看起來是這樣的:

\name{timestamps} 

\alias{timestamps} 
\alias{timestamps,.MoveTrack-method} 
\alias{timestamps,.MoveTrackSingle-method} 
\alias{"timestamps<-",.MoveTrack-method} 

\docType{methods} 

\title{Extract the timestamps of a Move or MoveStack object} 

\description{The timestmaps method returns or sets the timestamps of a track from a Move or MovesStack object.} 

\usage{ 
\S4method{timestamps}{.MoveTrackSingle}(this) 
\S4method{timestamps}{.MoveTrack}(this) 
\S4method{"timestamps<-"}{.MoveTrack}(this, value) 
} 

\arguments{ 
    \item{this}{Move or MoveStack object} 
    \item{value}{timestamps from class POSIXct} 
} 

和實際功能如下:

setGeneric("timestamps", function(this) standardGeneric("timestamps")) 
setMethod("timestamps", ".MoveTrack", 
    function(this) { 
     [email protected] 
    }) 

setMethod("timestamps", ".MoveTrackSingle", 
      function(this) { 
      [email protected] 
      }) 

setGeneric("timestamps<-", function(this, value) standardGeneric("timestamps<-")) 
setReplaceMethod("timestamps", ".MoveTrack", 
    function(this, value) { 
     [email protected] <- value 
     this 
    }) 

我搜索的電子但是我發現的所有內容都是關於Roxygen的文檔,這些文檔對我沒有幫助。我也嘗試過不同的文檔樣式,例如:

\S4method{"timestamps<-"}{.MoveTrack}(this, value) 
\S4method{"timestamps<-."}{.MoveTrack}(this, value) 
\S4method{"timestamps<-$"}{.MoveTrack}(this, value) 
\S4method{'timestamps<-'}{.MoveTrack}(this, value) 
\S4method{timestamps<-}{.MoveTrack}(this, value) 
\S4method{"timestamps\<\-"}{.MoveTrack}(this, value) 
\S4method{"timestamps\\<\\-"}{.MoveTrack}(this, value) 

但他們都不工作。任何想法? 非常感謝。 最好,MARCO

回答

2

嘗試

\S4method{timestamps}{.MoveTrack}(this) <- value 

在第二{}用逗號分開的名單多分派。

+0

感謝Martin以下工作:'\別名{時間戳< - }' 並在口服: 我在別名加入{。MoveTrack}'\ S4method {時間戳}(這)< - 值' all without quotes(但是,要從命名空間導出,我必須使用''timestamps < - '') 非常感謝! – 2012-08-14 14:00:12