[Bioc-devel] Is magrittr "%>%" acceptable in bioc packages?

Vincent Carey @tvjc @end|ng |rom ch@nn|ng@h@rv@rd@edu
Sat Aug 17 10:52:19 CEST 2019


On Sat, Aug 17, 2019 at 4:40 AM Venu Thatikonda <thatikonda92 using gmail.com>
wrote:

> Hi,
>
> As the title says, is %>% acceptable in bioc packages? With BiocCheck, I
> get a WARNING that is "Add non-empty \\value sections to the following man
> pages: man/pipe.Rd".
>

Yes magrittr is acceptable.  The warning says (I think) that you have a man
page for
a topic 'pipe' but did not put a \value section for the man page.  If using
roxygen you
would want to have a @return element in your documentation, to avoid this
warning.


> Is it okay even if this warning appears ? `R CMD check` didn't give
> warnings about it.
>

Try to avoid the warning.  If you have difficulty, report back.


>
> Thank you.
>
> --
> Best regards
> Venu Thatikonda
> https://itsvenu.github.io/
>
>         [[alternative HTML version deleted]]
>
> _______________________________________________
> Bioc-devel using r-project.org mailing list
> https://stat.ethz.ch/mailman/listinfo/bioc-devel
>

-- 
The information in this e-mail is intended only for the ...{{dropped:18}}



More information about the Bioc-devel mailing list