[Rd] R CMD check warning with S3 method

Duncan Murdoch murdoch.duncan at gmail.com
Fri Jun 20 09:40:53 CEST 2014


On 20/06/2014, 8:34 AM, Yihui Xie wrote:
> but note that you will have to document it even if it is a function
> imported from another package... 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?

Only that you can have a link to the help page in the other package, e.g.

\code{\link[emdbook]{curve3d}}

You'll still need to copy the required parts, but you can link to the
original for the rest.

Duncan Murdoch

> 
> 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!
>>
> 
> ______________________________________________
> R-devel at r-project.org mailing list
> https://stat.ethz.ch/mailman/listinfo/r-devel
>



More information about the R-devel mailing list