QCBSRworkshops / presenter-developer-protocol

Guidelines and responsibilities of workshop instructors and developers
http://r.qcbs.ca/presenter-developer-protocol/
MIT License
0 stars 0 forks source link

Code formatting guidelines #14

Open KevCaz opened 4 years ago

KevCaz commented 4 years ago

It would be nice to introduce some guidelines for code formatting of the workshops (both inline code and code chunks).

For instance, in code chunk we could use:

var <- 2

Instead of

var = 2

Another example, for the inline code, when a function is mentioned we could use

In what follows we will be using plot()

rather than

In what follows we will be using plot

Looks like details but it makes it easier to read the code and understand what we are referring to.

KevCaz commented 4 years ago

Similarly,