[Bioc-devel] Format roxgen comment (alternative to formatR)

[Kern, Lori]

It looks like Mike had a nice answer on the support site
https://support.bioconductor.org/p/9139641/


Lori Shepherd

Bioconductor Core Team

Roswell Park Comprehensive Cancer Center

Department of Biostatistics & Bioinformatics

Elm & Carlton Streets

Buffalo, New York 14263

________________________________
From: Bioc-devel <bioc-devel-bounces using r-project.org> on behalf of Jean-Philippe Villemin <jpvillemin using gmail.com>
Sent: Wednesday, September 22, 2021 4:00 AM
To: bioc-devel using r-project.org <bioc-devel using r-project.org>
Subject: [Bioc-devel] Format roxgen comment (alternative to formatR)

Hi all,

From BiocCheck :

   - NOTE: Consider shorter lines; 501 lines (14%) are > 80 characters long.

Most of these lines are roxygen comments.

formatR package says :

Also note that single lines of long comments will be wrapped into shorter
ones automatically when wrap = TRUE, but roxygen comments will not be
wrapped (i.e., comments that begin with #').

Don't tell me I have to do this one line per line. Please.


The other main NOTE is about size of function. So I cut function into
2parts , remove blank line, but it's not adding clarity. I found it weird.
Shorter line should be given as advice before size of lines because then
you try to address function size problem first, and you have to handle size
of lines, that will again may change size function.


Of note, I already post on Bioconductor support but I realised then that
the bioc-devel mailing list might be more appropriate.


Sorry for duplicate.



--
*Jean-Philippe Villemin   *- Bioinformatics, PhD -

Cancer Bioinformatics and Systems Biology

Institut de Recherche en Canc�rologie de Montpellier

Inserm U1194


*jpvillemin using gmail.com <jpvillemin using gmail.com>*

        [[alternative HTML version deleted]]

_______________________________________________
Bioc-devel using r-project.org mailing list
https://secure-web.cisco.com/1MNoeG9a9chrE50HwMdQnmG_RUB4VkNRgiO5jQe4z7C-mVGGHOJiTPtgma_jbHbRmrqieDqaIn5RnzoBhJmuiCLWdhLzHPAyGbsXJETAmQUmFGJKS8TJTujKHkXCIESWmKUN5n9WLzX2uJe6UchOFmVrsDc4yUAwX0U468c61HJhuN_A8ZPT_4ha_U7-HnywWopt9nUkiCPCuMoVhKUxc02lne0C6RRVwdfQINTL9jmG6b8GWms6iMbO5lyDXdvAoeyKzHLUYz4Cna9ml69Ll68njCZJOmOok-5Ltx-U5gXddDajdUZ-BKxxYBnTStw1Zc78t9qXl-TDgIscYO85vTA/https%3A%2F%2Fstat.ethz.ch%2Fmailman%2Flistinfo%2Fbioc-devel



This email message may contain legally privileged and/or confidential information.  If you are not the intended recipient(s), or the employee or agent responsible for the delivery of this message to the intended recipient(s), you are hereby notified that any disclosure, copying, distribution, or use of this email message is prohibited.  If you have received this message in error, please notify the sender immediately by e-mail and delete this email message from your computer. Thank you.
	[[alternative HTML version deleted]]