From hb at stat.berkeley.edu  Wed Apr  7 18:42:18 2010
From: hb at stat.berkeley.edu (Henrik Bengtsson)
Date: Wed, 7 Apr 2010 18:42:18 +0200
Subject: [Rd] generic '[' for a non-exported class
In-Reply-To: <4BBCAF12.1030303@userprimary.net>
References: <4BBC3D9D.2080001@u-paris10.fr> <4BBCAF12.1030303@userprimary.net>
Message-ID: <x2v59d7961d1004070942h2122eeb4nc16d4bf36c090551@mail.gmail.com>

On Wed, Apr 7, 2010 at 6:13 PM, Seth Falcon <seth at userprimary.net> wrote:
> On 4/7/10 1:09 AM, Christophe Genolini wrote:
>>
>> Hi all,
>> I define a S4 class 'foo'. I define '[' and '[<-' for it.
>> I do not want to export foo, so I do not put it in NAMESPACE.
>> I do not want to export '[' and '[<-' either (since the user can not use
>> foo, no raison to give him access to '[' for foo).
>>
>> But R CMD check does not agree with me and report an error:
>> Undocumented S4 methods:
>> generic '[' and siglist 'foo'
>> generic '[<-' and siglist 'foo'
>>
>>
>> Any solution ?
>
> You can document these on an internal API Rd page. ?Create an Rd file like
> yourPkg-internal-api.Rd and add the appropriate \alias{} lines to it.

...with Rd \keyword{internal} on that Rd page (so it does not show up
on the Rd help index page).

/Henrik

>
> + seth
>
> --
> Seth Falcon | @sfalcon | http://userprimary.net/
>
> ______________________________________________
> R-devel at r-project.org mailing list
> https://stat.ethz.ch/mailman/listinfo/r-devel
>



[Rd] generic '[' for a non-exported class
Henrik Bengtsson