From plummerm at iarc.fr  Fri Jun 20 10:37:26 2014
From: plummerm at iarc.fr (Martyn Plummer)
Date: Fri, 20 Jun 2014 08:37:26 +0000
Subject: [Rd] R CMD check warning with S3 method
In-Reply-To: <CANROs4fBWPkhPXKV+AkTXCXPx0aFkpt97u2yyboMMp8teeNvMw@mail.gmail.com>
References: <CAFOpNVGGT+tpdAZ42Q+jkWntAE+N=Ctq_D5pKbVVHx7F6_m0RQ@mail.gmail.com>
	<1403198095.17749.166.camel@braque.iarc.fr>
	<CAFOpNVF3Q2nN7jUpCvoqGh_Q0PEpMFgP7KQxrymQxHWUX86YvA@mail.gmail.com>
	<31E214B6DF75104E942856C2F74953CB0519C64C@exchange>
	<CAFOpNVGDzUUtGnWmX3dakGgsnRMG0q+cMFY7WYtWhM98dJrPqg@mail.gmail.com>
	<CANROs4fBWPkhPXKV+AkTXCXPx0aFkpt97u2yyboMMp8teeNvMw@mail.gmail.com>
Message-ID: <1403253447.17749.176.camel@braque.iarc.fr>

On Fri, 2014-06-20 at 01:34 -0500, Yihui Xie wrote:
> but note that you will have to document it even if it is a function
> imported from another package... 

Let's not go round in circles. I already pointed this out in my earlier
reply to Winston. It has been snipped from the thread history so I'll
repeat it here:

"You will also need to document the generic function in your package. A
minimal functioning help page that cross-references to the dplyr package
should be sufficient"

Duncan gives more details on the cross reference in his reply.

> Perhaps help() should be intelligent
> enough to link the documentation of `FUN` from package A for package B
> when B imports `FUN` from A, and exports it in B's NAMESPACE. The
> package name of A may be obtained from
> environmentName(environment(FUN)). At the moment, since R CMD check
> will warn against the missing documentation of `FUN` in B, I have to
> copy FUN.Rd from A to B in this case, which seems to be inefficient
> and not a best way to maintain. Did I miss anything in the R-exts
> manual?

> Regards,
> Yihui
> --
> Yihui Xie <xieyihui at gmail.com>
> Web: http://yihui.name
> 
> 
> On Fri, Jun 20, 2014 at 12:19 AM, Winston Chang <winstonchang1 at gmail.com> wrote:
> > On Thu, Jun 19, 2014 at 3:15 PM, Martyn Plummer <plummerm at iarc.fr> wrote:
> >
> >>  Export filter in the NAMESPACE file *without copying it* in the R source
> >> code.
> >>
> >>
> > Ah, it works! Thank you!
> >

-----------------------------------------------------------------------
This message and its attachments are strictly confidenti...{{dropped:8}}



[Rd] R CMD check warning with S3 method
Martyn Plummer