search

dfe-analytical-services / r-training-course

Introductory training course for R, using the published School Workforce Census
https://dfe-analytical-services.github.io/r-training-course/
4 stars 2 forks source link

Chapter 3 adding good coding practice #14

Closed TomFranklin closed 5 years ago

TomFranklin commented 6 years ago

I think it'd be good to do a section on what we see as good coding practice. @adamrobinson361 mentioned yesterday having a good readme in each project to give users an idea of what's going on. I agree that's a good idea, but also think we should have some set style of teaching coding. @matt-dray mentioned a shortcut to add -------'s across code to break sections. Would be good to hear both your thoughts on this one!

TomFranklin commented 6 years ago

Would also be good to adopt and stick with one of the cases stated in 3.1. snake_case etc. and to be consistent with it across the tutorial

adamrobinson361 commented 6 years ago

Referring to the hadley style guide and bringing out some of the key points but also linking to it: http://adv-r.had.co.nz/Style.html