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

Andreas Borg andreas.borg at unimedizin-mainz.de
Mon Feb 21 11:17:36 CET 2011


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
Medizinische Informatik

UNIVERSITÄTSMEDIZIN
der Johannes Gutenberg-Universität
Institut für Medizinische Biometrie, Epidemiologie und Informatik
Obere Zahlbacher Straße 69, 55131 Mainz
www.imbei.uni-mainz.de

Telefon +49 (0) 6131 175062
E-Mail: borg at imbei.uni-mainz.de

Diese E-Mail enthält vertrauliche und/oder rechtlich geschützte Informationen. Wenn Sie nicht der
richtige Adressat sind oder diese E-Mail irrtümlich erhalten haben, informieren Sie bitte sofort den
Absender und löschen Sie diese Mail. Das unerlaubte Kopieren sowie die unbefugte Weitergabe
dieser Mail und der darin enthaltenen Informationen ist nicht gestattet.



More information about the R-devel mailing list