styleguide R code has no referral to tidyverse style guide

[florisvdh]

While reading into issue #116 on the INBO R styleguide, and myself rather using the tidyverse style guide, I wonder why we don't just refer to the latter and redirect people there (and if needed, propose enhancements there). It seems to me that we want to adhere to it anyway. Maybe I overlook things ;-)

Currently, there is no referral to the tidyverse style guide at all, which is the main point of this issue.

[peterdesmet]

I agree, good point!

[peterdesmet]

The Tidyverse style guide is good and community maintained, so pointing to that one (with maybe some specific INBO clarifications) would be less maintenance for us. @ThierryO is there much in our style guide that differs from the Tidyverse style guide? If so, are there good reasons for them?

[ElsLommelen]

Ok to refer to it as an additional guideline. As it is rather long, I think it would be nice to keep a short list of the most important rules/guidelines in our tutorial (to not force everyone to read the whole guideline). And of course the items that are specific for INBO.

From memory: adding INBO as copyrighter is something that is unique to our guideline. ;-)

[ElsLommelen]

While working on PR #117, I'm wondering: is the guideline not growing too long for one page? If I am not mistaken, it was first written for package development (some years ago), and only after a comment I noticed it is now used more general. Because all different subjects are mixed, it becomes a bit confusing and difficult to pick the right things.

Would it be a good idea to split this page in 3 different pages?

• one page on coding style that is useful for all users (Scope, Syntax and sections R script and RMarkdown under File Structure?)
• one page on subjects specific to package development (Documentation and File Structure / R Package?)
• one page on recommended packages

[florisvdh]

After discussion yesterday: current suggestion is to refer to the checklist package for this, instead of maintaining a separate styleguide.

Further, if a vignette in checklist is/becomes available on this topic, this tutorial page can be dropped after handling #262.