[metrics-bugs] #24707 [Metrics]: Define R coding guidelines for Metrics' products

Tor Bug Tracker & Wiki blackhole at torproject.org
Mon Mar 12 11:50:19 UTC 2018


#24707: Define R coding guidelines for Metrics' products
-------------------------+------------------------------
 Reporter:  iwakeh       |          Owner:  metrics-team
     Type:  enhancement  |         Status:  new
 Priority:  Medium       |      Milestone:
Component:  Metrics      |        Version:
 Severity:  Normal       |     Resolution:
 Keywords:               |  Actual Points:
Parent ID:               |         Points:
 Reviewer:               |        Sponsor:
-------------------------+------------------------------

Comment (by iwakeh):

 Ok, so it seems there is convergence around the tidyverse style guide.  As
 the style guide linked in comment:5 is hard to copy or download (at least
 I couldn't find the repo or link) and lintr is configurable and its
 documentation points to a different resource by the same author (Hadley
 Wickham) I'd suggest to use
 [https://github.com/hadley/r-pkgs/blob/master/style.rmd Wickham's guide],
 which is under cc license, in the same way we used Google's for Java,
 i.e., copy it to a wiki page, state additional points or style's were we
 diverge, and also provide a lintr collection of linters that enforce our
 style choices.

 Next steps:
 * add R style guide to wiki
 * define additions and divergions (ongoing process)
 * provide an Ant task for apllying lintr in the way we apply checkstyle
 checks

 What is missing?

--
Ticket URL: <https://trac.torproject.org/projects/tor/ticket/24707#comment:9>
Tor Bug Tracker & Wiki <https://trac.torproject.org/>
The Tor Project: anonymity online


More information about the metrics-bugs mailing list