[Bioc-devel] promptClass

[Seth Falcon]

cstrato <cstrato at aon.at> writes:

> Dear all,
>
> What is the best way to write the docs for S4 classes?
>
> Concretely, is it  possible to include the methods in the class 
> documentation?
> For example, the documentation for class "AffyBatch" contains all methods.
> However, when I do:
>    promptClass("AffyBatch")
> the relevant output of file "AffyBatch-class.Rd" is:
>    \section{Methods}{
>    No methods defined with class "AffyBatch" in the signature.
>    }

promptClass used to provide more useful output.  You might want to
report the issue on one of the R lists.

> Since PromptClass() contains a parameter "where" is it possible to use 
> it, and how?

I'm not sure that is relevant here.

One thing that can be useful here is showMethods(classes="AffyBatch").
The problem with static documentation for methods is that what methods
are available can change based on what packages are attached.

If showMethods or a wrapper for it could be convinced to output a link
to a help file, then it might actually be a good way to go...

+ seth

-- 
Seth Falcon | Computational Biology | Fred Hutchinson Cancer Research Center
http://bioconductor.org