S4 class help pages [Sec=Unclassified]

An embedded and charset-unspecified text was scrubbed...
Name: not available
URL: <https://stat.ethz.ch/pipermail/r-devel/attachments/20101004/0c32d245/attachment.pl>
Hi,

I am working on producing an R package containing mostly S4 classes and methods.
I have generated and filled out all the necessary .Rd files but find that once installed I am unable to access help pages for the classes using the ?package::classname-class syntax that is suggested when using the ?? apropos search.  This lists my package classes and the class help pages.  Instead, the "Arithmetic Operators" help page is always loaded.  I can load the pages I want via links like \linkS4class{classname} in my package help page.

I have played with a couple of other packages and see the same problem.  Is there a different syntax to access these S4 class help pages rather than ?package::classname-class?
The problem is the parsing:  that is parsed as `?`(stats4::mle - class), 
i.e. there's a subtraction there, not a name with a hyphen in it.  So 
you're seeing help on subtraction.

You can get what you want with class?stats4::mle.

I'll see if I can fix the advice from ??.

Duncan Murdoch
Thanks

Troy

___________________________________________________________________________

     Australian Antarctic Division - Commonwealth of Australia
IMPORTANT: This transmission is intended for the addressee only. If you are not the
intended recipient, you are notified that use or dissemination of this communication is
strictly prohibited by Commonwealth law. If you have received this transmission in error,
please notify the sender immediately by e-mail or by telephoning +61 3 6232 3209 and
DELETE the message.
         Visit our web site at http://www.antarctica.gov.au/
___________________________________________________________________________

	[[alternative HTML version deleted]]

______________________________________________
R-devel at r-project.org mailing list
https://stat.ethz.ch/mailman/listinfo/r-devel
-----Original Message-----
From: Duncan Murdoch [mailto:murdoch.duncan at gmail.com]
Sent: Monday, 4 October 2010 11:09 PM
To: Troy Robertson
Cc: 'r-devel at R-project.org'
Subject: Re: [Rd] S4 class help pages [Sec=Unclassified]

  On 04/10/2010 12:14 AM, Troy Robertson wrote:
Hi,

I am working on producing an R package containing mostly S4 classes
and methods. I have generated and filled out all the necessary .Rd
files but find that once installed I am unable to access help pages
for the classes using the ?package::classname-class syntax that is
suggested when using the ?? apropos search.  This lists my package
classes and the class help pages.  Instead, the "Arithmetic
Operators"
help page is always loaded.  I can load the pages I want via links
like \linkS4class{classname} in my package help page.

I have played with a couple of other packages and see the same
problem.  Is there a different syntax to access these S4 class help
pages rather than ?package::classname-class?
The problem is the parsing:  that is parsed as
`?`(stats4::mle - class), i.e. there's a subtraction there,
not a name with a hyphen in it.  So you're seeing help on subtraction.

You can get what you want with class?stats4::mle.

I'll see if I can fix the advice from ??.

Duncan Murdoch

Thanks

Troy
Cheers Duncan,

Both your suggestions do the trick.
i.e. class?stats4::mle and ?stats4::`mle-class`

Troy
___________________________________________________________________________

    Australian Antarctic Division - Commonwealth of Australia
IMPORTANT: This transmission is intended for the addressee only. If you are not the
intended recipient, you are notified that use or dissemination of this communication is
strictly prohibited by Commonwealth law. If you have received this transmission in error,
please notify the sender immediately by e-mail or by telephoning +61 3 6232 3209 and
DELETE the message.
        Visit our web site at http://www.antarctica.gov.au/
___________________________________________________________________________