Skip to content

Problem with documentation of user-defined operator (S4 method)

2 messages · Andreas Borg

Original
Andreas Borg
# 
Dear list members,

I have defined a binary operator %append% with methods for some S4 
classes. In my documentation file, I want to list the methods explicitly 
by using e.g.:

    \S4method{\%append\%}{RecLinkData,RecLinkData}(x, y)

In the HTML documentation this comes out right as
   
    ## S4 method for signature 'RecLinkResult,RecLinkResult'
    x %append% y

, but R CMD check raises the following warning:

    Bad \usage lines found in documentation object '%append%-methods':
      <unescaped bksl>S4method{%append%}{RecLinkData,RecLinkData}(x, y)

Any idea what is wrong?

I have seen this behaviour with R 2.12.0 and 2.12.1.

Best regards and thanks for any suggestion,

Andreas
Andreas Borg
# 
Just to add this, the operator is defined as follows:

standardGeneric for "%append%" defined from package "RecordLinkage"

function (x, y)
standardGeneric("%append%")
<environment: 01b19a3c>
Methods may be defined for arguments: x, y
Use  showMethods("%append%")  for currently available ones.

So this is not a problem of misspelled arguments. The involved class is 
an S3 class made usable to S4 methods by "oldClass".

Andreas Borg schrieb: