Is magrittr "%>%" acceptable in bioc packages?

0

Entering edit mode

venu • 0

@venu-9606

Last seen 5.4 years ago

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".

Is it okay even if this warning appears or should hack it to suppress?

Thank you.

R bioconductor • 835 views

ADD COMMENT • link updated 5.4 years ago by Martin Morgan 25k • written 5.4 years ago by venu • 0

2

Entering edit mode

Aaron Lun ★ 28k

@alun

Last seen 8 hours ago

The city by the bay

Ah, that's a raw nerve right there.

This question is better placed in the Bioc-devel mailing list, which is where all topics of discussion for package development should go. The support site is intended for users to ask questions about... well, using the packages.

But FWIW, no.

ADD COMMENT • link 5.4 years ago Aaron Lun ★ 28k

0

Entering edit mode

Thanks Aaron, I will ask at mailing list.

But FWIW, no. - you mean, I can't use pipe in bioc packages?

ADD REPLY • link 5.4 years ago venu • 0

0

Entering edit mode

Martin Morgan 25k

@martin-morgan-1513

Last seen 5 months ago

United States

The complaint is about a missing \value{} section, which in roxygen-speak is a missing @return tag in the documentation chunk that creates the 'pipe.Rd' man page.

ADD COMMENT • link 5.4 years ago Martin Morgan 25k

0

Entering edit mode

I get the problem is due to @return tag, we use pipe in many different settings, just wondering what to write with @return. R CMD check didn't complain about it. As Aaron suggested above, I will ask the question at mailing list. Thank you.

ADD REPLY • link 5.4 years ago venu • 0

Login before adding your answer.