Stone_Red/naming-convention
1
0
Fork 0
mirror of https://github.com/Stone-Red-Code/naming-convention.git synced 2026-09-04 09:06:19 +02:00
Code Issues Packages Projects Releases Wiki Activity

Update R style guide and name convention.md

Browse Source
This commit is contained in:
eshcherbakova
2015-05-05 13:47:37 +03:00
parent cf8b89fac1
commit 76d91102f5
1 changed files with 7 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files
R style guide and name convention.md
+7
View File
@@ -34,6 +34,7 @@ Don't use underscores ( _ ) or hyphens ( - ) in identifiers. Identifiers should
**BAD:** calculate_avg_clicks , calculateAvgClicks **BAD:** calculate_avg_clicks , calculateAvgClicks
Make function names verbs. Make function names verbs.
*Exception: When creating a classed object, the function name (constructor) and class should match (e.g., lm).* *Exception: When creating a classed object, the function name (constructor) and class should match (e.g., lm).*
- kConstantName - kConstantName
@@ -46,11 +47,13 @@ The maximum line length is 80 characters.
### Indentation ### Indentation
When indenting your code, use two spaces. Never use tabs or mix tabs and spaces. When indenting your code, use two spaces. Never use tabs or mix tabs and spaces.
*Exception: When a line break occurs inside parentheses, align the wrapped line with the first character inside the parenthesis.* *Exception: When a line break occurs inside parentheses, align the wrapped line with the first character inside the parenthesis.*
### Spacing ### Spacing
Place spaces around all binary operators (=, +, -, <-, etc.). Place spaces around all binary operators (=, +, -, <-, etc.).
*Exception: Spaces around ='s are optional when passing parameters in a function call.* *Exception: Spaces around ='s are optional when passing parameters in a function call.*
Do not place a space before a comma, but always place one after a comma. Do not place a space before a comma, but always place one after a comma.
@@ -90,6 +93,7 @@ plot (x = x.coord,
main = (paste(metric, " for 3 samples ", sep = ""))) main = (paste(metric, " for 3 samples ", sep = "")))
``` ```
Do not place spaces around code in parentheses or square brackets. Do not place spaces around code in parentheses or square brackets.
*Exception: Always place a space after a comma.* *Exception: Always place a space after a comma.*
**GOOD:** **GOOD:**
@@ -105,6 +109,7 @@ x[1,] # Needs a space after the comma
### Curly Braces ### Curly Braces
An opening curly brace should never go on its own line; a closing curly brace should always go on its own line. You may omit curly braces when a block consists of a single statement; however, you must consistently either use or not use curly braces for single statement blocks. An opening curly brace should never go on its own line; a closing curly brace should always go on its own line. You may omit curly braces when a block consists of a single statement; however, you must consistently either use or not use curly braces for single statement blocks.
**GOOD:** **GOOD:**
``` ```
if (is.null(ylim)) { if (is.null(ylim)) {
@@ -125,6 +130,7 @@ if (is.null(ylim)) {ylim <- c(0, 0.06)}
Surround "else" with braces. Surround "else" with braces.
An "else" statement should always be surrounded on the same line by curly braces. An "else" statement should always be surrounded on the same line by curly braces.
**GOOD:** **GOOD:**
``` ```
if (condition) { if (condition) {
@@ -197,6 +203,7 @@ hist(df$pct.spent,
Function definitions should first list arguments without default values, followed by those with default values. Function definitions should first list arguments without default values, followed by those with default values.
In both function definitions and function calls, multiple arguments per line are allowed; line breaks are only allowed between assignments. In both function definitions and function calls, multiple arguments per line are allowed; line breaks are only allowed between assignments.
**GOOD:** **GOOD:**
``` ```
PredictCTR <- function(query, property, numDays, PredictCTR <- function(query, property, numDays,