From seth at userprimary.net  Wed Apr  7 18:13:06 2010
From: seth at userprimary.net (Seth Falcon)
Date: Wed, 07 Apr 2010 09:13:06 -0700
Subject: [Rd] generic '[' for a non-exported class
In-Reply-To: <4BBC3D9D.2080001@u-paris10.fr>
References: <4BBC3D9D.2080001@u-paris10.fr>
Message-ID: <4BBCAF12.1030303@userprimary.net>

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.

+ seth

-- 
Seth Falcon | @sfalcon | http://userprimary.net/



[Rd] generic '[' for a non-exported class
Seth Falcon