132 |
133 |
Spacing
134 |
135 | - Place spaces around all binary operators such as
=, +, -, <-, etc.
136 | - Place a space before the
(, except in a function call
137 | - Use space after a comma
138 |
139 |
140 |
141 | {% highlight R %}
142 | # Good
143 | someFunction <- function(a, b, c, d = 100) {
144 | if (a < d) {
145 | a <- (b + c) * d
146 | }
147 | }
148 |
149 | # Bad
150 | someFunction <- function(a,b,c,d= 100) {
151 | if(a
155 |
156 |
157 |
158 |
159 |
Curly Braces
160 |
161 | - Do not place
{ on its own line
162 | - Place
} on its own line unless followed by else
163 | - Surround
else statements with curly braces
164 |
165 |
166 |
167 | {% highlight R %}
168 | # Good
169 | if (a < d) {
170 | a <- (b + c) * d
171 | } else {
172 | a <- d
173 | }
174 |
175 | # Bad
176 | if (a < d)
177 | {
178 | a <- (b + c) * d
179 | } else a <- d
180 | {% endhighlight %}
181 |
182 |
183 |
184 |
185 |
186 |
Line Length
187 |
188 | - Keep each line less than 80 characters
189 | - Align lines by shared features like parameters if possible
190 |
191 |
192 |
193 | {% highlight R %}
194 | # Good
195 | someFunction(optionA = alpha,
196 | optionB = bravo,
197 | optionC = charlie,
198 | optionD = delta)
199 |
200 | # Acceptable
201 | someFunction(optionA = alpha,
202 | optionB = bravo, optionC = charlie,
203 | optionD = delta)
204 |
205 | # Bad
206 | someFunction(optionA = alpha, optionB = bravo, optionC = charlie, optionD = delta)
207 | {% endhighlight %}
208 |
209 |
210 |
211 |
212 |
Organization
213 |
214 |
215 |
249 |
250 |
251 |
252 |
Additional Tips
253 |
254 |
255 |
256 |
257 |
Loops
258 |
259 | - Use
seq(along = x) to protect against instances where x is empty
260 | - Use
apply, lapply, etc when possible
261 |
262 |
263 |
264 | {% highlight R %}
265 | # Good
266 | lapply(seq(along = x), function(i) {
267 | doSomething(i)
268 | })
269 |
270 | # Acceptable
271 | for (i in seq(along = x)) {
272 | doSomething(i)
273 | }
274 |
275 | # Bad
276 | for (i in 1:length(x)) {
277 | doSomething(i)
278 | }
279 | {% endhighlight %}
280 |
281 |
282 |
283 |
284 |
Repeat
285 |
286 | - Use
repeat for better interpretability
287 |
288 |
289 |
290 | {% highlight R %}
291 | # Good
292 | repeat {
293 | ...
294 | }
295 |
296 | # Bad
297 | while (TRUE) {
298 | ...
299 | }
300 | {% endhighlight %}
301 |
302 |
303 |
304 |
305 |
306 |
References and Resources
307 |
308 |
309 |
319 |
325 |
326 |
327 |
--------------------------------------------------------------------------------
/stylesheet.css:
--------------------------------------------------------------------------------
1 | ---
2 | layout: nil
3 | ---
4 |
5 |
6 | /*
7 | * Fonts
8 | */
9 |
10 | @font-face {
11 | font-family: 'fontello';
12 | src: url('font/fontello.eot');
13 | src: url('font/fontello.eot#iefix') format('embedded-opentype'),
14 | url('font/fontello.woff') format('woff'),
15 | url('font/fontello.ttf') format('truetype'),
16 | url('font/fontello.svg') format('svg');
17 | font-weight: normal;
18 | font-style: normal;
19 | }
20 |
21 | [class^="icon-"]:before, [class*=" icon-"]:before {
22 | font-family: "fontello";
23 | font-style: normal;
24 | font-weight: normal;
25 | speak: none;
26 | display: inline-block;
27 | text-decoration: inherit;
28 | width: 1em;
29 | margin-right: .2em;
30 | text-align: center;
31 | font-variant: normal;
32 | text-transform: none;
33 | }
34 |
35 | .icon-github-circled:before { content: '\e800'; } /* '' */
36 | .icon-twitter:before { content: '\e801'; } /* '' */
37 |
38 |
39 | /*
40 | * Scaffolding and type
41 | */
42 |
43 | html {
44 | font-size: 16px;
45 | }
46 | @media (min-width: 48em) {
47 | html {
48 | font-size: 20px;
49 | }
50 | }
51 |
52 | body {
53 | margin: 0;
54 | font: 1rem/1.5 "PT Sans", sans-serif;
55 | color: #5a5a5a;
56 | }
57 |
58 | a {
59 | color: #08c;
60 | text-decoration: none;
61 | }
62 | a:hover {
63 | text-decoration: underline;
64 | }
65 |
66 | h1, h2, h3, h4 {
67 | margin: 0 0 .5rem;
68 | font-weight: normal;
69 | line-height: 1;
70 | color: #2a2a2a;
71 | letter-spacing: -.05em;
72 | }
73 | h1 { font-size: 3rem; }
74 | h2 { font-size: 2.5rem; }
75 | h3 { font-size: 1.75rem; }
76 | h4 { font-size: 1.25rem }
77 |
78 | p {
79 | margin: 0 0 1rem;
80 | }
81 | .lead {
82 | font-size: 1.3rem;
83 | }
84 |
85 | blockquote {
86 | position: relative;
87 | margin: 0 1rem 1rem;
88 | font-style: italic;
89 | color: #7a7a7a;
90 | }
91 | blockquote p {
92 | margin-bottom: 0;
93 | }
94 |
95 | ul li {
96 | margin-bottom: .25rem;
97 | }
98 |
99 | /* Tighten up margin on last items */
100 | p:last-child,
101 | ul:last-child,
102 | blockquote:last-child{
103 | margin-bottom: 0;
104 | }
105 |
106 |
107 |
108 | /*
109 | * Code
110 | */
111 |
112 | code,
113 | pre {
114 | font-family: "PT Mono", Menlo, "Courier New", monospace;
115 | font-size: 95%;
116 | }
117 | code {
118 | padding: 2px 4px;
119 | font-size: 85%;
120 | color: #d44950;
121 | background-color: #f7f7f9;
122 | border-radius: .2rem;
123 | }
124 |
125 | pre {
126 | display: block;
127 | margin: 0 0 1rem;
128 | line-height: 1.4;
129 | white-space: pre;
130 | white-space: pre-wrap;
131 | }
132 | pre code {
133 | padding: 0;
134 | color: inherit;
135 | background-color: transparent;
136 | border: 0;
137 | }
138 | .highlight {
139 | margin: 0;
140 | }
141 | .highlight pre {
142 | margin-bottom: 0;
143 | }
144 | .highlight + .highlight {
145 | margin-top: 1rem;
146 | }
147 |
148 |
149 | /*
150 | * The Grid
151 | */
152 |
153 | .col {
154 | padding: 2rem 1rem;
155 | }
156 | .col p {
157 | max-width: 40rem;
158 | }
159 | .col + .col {
160 | border-top: 1px solid #dfe1e8;
161 | background-color: #f7f7f9;
162 | }
163 | @media (min-width: 38em) {
164 | .col {
165 | padding: 2rem;
166 | }
167 | }
168 | @media (min-width: 48em) {
169 | .section {
170 | display: table;
171 | width: 100%;
172 | table-layout: fixed;
173 | }
174 | .col {
175 | display: table-cell;
176 | padding: 3rem;
177 | vertical-align: top;
178 | }
179 | .col + .col {
180 | border-top: 0;
181 | }
182 | }
183 |
184 | /* Make the ToC a whole section */
185 | .toc .col + .col {
186 | background-color: #fff;
187 | }
188 |
189 |
190 | /*
191 | * Masthead
192 | */
193 |
194 | .masthead {
195 | padding: 3rem 1rem;
196 | color: rgba(255,255,255,.5);
197 | text-align: center;
198 | background-color: #428bca;
199 | }
200 | .masthead h1 {
201 | color: #fff;
202 | margin-bottom: .25rem;
203 | }
204 | .masthead .icon {
205 | display: inline-block;
206 | font-size: 3rem;
207 | margin: 0 .5rem;
208 | }
209 | .masthead-links {
210 | font-size: 2rem;
211 | }
212 | .masthead-links a {
213 | color: rgba(255,255,255,.5);
214 | text-decoration: none;
215 | transition: all .15s linear;
216 | }
217 | .masthead-links a:hover {
218 | color: #fff;
219 | }
220 |
221 | @media (min-width: 38em) {
222 | .masthead {
223 | padding-top: 4rem;
224 | padding-bottom: 4rem;
225 | }
226 | }
227 |
228 |
229 | /*
230 | * Sections
231 | */
232 |
233 | .heading {
234 | padding: 2rem 1rem 1.5rem;
235 | background-color: #2f6391;
236 | }
237 | .heading h2 {
238 | color: #fff;
239 | }
240 |
241 | @media (min-width: 38em) {
242 | .heading {
243 | padding: 3rem 3rem 2.5rem;
244 | }
245 | }
246 |
247 | .section {
248 | border-bottom: 1px solid #dfe1e8;
249 | }
250 |
251 |
252 | /*
253 | * Footer
254 | */
255 |
256 | .footer {
257 | padding: 3rem 1rem;
258 | font-size: 90%;
259 | text-align: center;
260 | }
261 | .footer p {
262 | margin-bottom: .5rem;
263 | }
264 |
265 | .quick-links {
266 | list-style: none;
267 | margin-left: 0;
268 | }
269 | .quick-links li {
270 | display: inline;
271 | }
272 |
273 |
274 | /*
275 | * Syntax highlighting
276 | */
277 |
278 | {% include syntax.css %}
279 |
280 |
--------------------------------------------------------------------------------