[Bioc-devel] How critical is package style for bioconductor?

[Turaga, Nitesh]

As long as it’s consistent, you can use another style. Consistency helps reviewers read the code easily.

Most people generally use “camelCase" or “snake_case" for variable names and function names.  But keep in mind that class names need to be “CamelCase" as that is the R style of doing things.

You should follow the other set of rules as given (such as Indentation, File names, Class names, use of space, comments, Namespaces, end user messages, Misc section) http://bioconductor.org/developers/how-to/coding-style/.

Best,

Nitesh


On Feb 26, 2019, at 11:00 AM, Aaron Chevalier <atgc using bu.edu<mailto:atgc using bu.edu>> wrote:

Hi all,

I'm developing a package that to submit to Bioconductor and I've noticed
that the style guide suggests camelCasealternatingWords which I find hard
to read and is different from other style guides and automated
style-checking I've seen (lintr, Hadley Wickam).

Is this an optional requirement that can be done with another consistent
style, or if not are there packages that enforce this style guide in an
automated fashion? I tried BiocCheck and it said nothing about the naming
conventions.

Thanks!

[[alternative HTML version deleted]]

_______________________________________________
Bioc-devel using r-project.org<mailto:Bioc-devel using r-project.org> mailing list
https://stat.ethz.ch/mailman/listinfo/bioc-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]]