R语言编码规范

1.一般性规则

(1)避免使用attach
(2)写函数时尽量少的使用stop()
(3)定义S3和S4的对象不要混在一起使用。

2.文件命名

(1)文件名应以.R结尾,文件名本身要有意义,如:predict_ad_revenue.R
(2)R代码就放在.R文件中,而R数据文件则放在.RData文件中。

3.变量名和函数命名规则

注意,在R环境下,大小写是敏感的。
1.变量名应都用小写字母,单词间用.分隔。
2.函数名的每个单词用大写字母开头,不用.连接。
3.常数项与函数命名规则一致,但以小写k开头。
以下举例说明:
变量:avg.clicks
函数名:CalculateAvgClicks用动词命名函数;
常数项:kConstantName

4.R语句

(1)单行长度
每行最长80个字符。
(2)缩进
使用两个空格来缩进代码,不要使用制表符或混合使用二者。
(3)空格
1.在所有二次运算符(=,+,-,<-,等)的两侧加上空格。
2.不可在逗号前加空格,逗号后必须加空格。
例如:tabPrior <- table(df[df$daysFromOpt < 0, "campaignid"])
3.括号左边用空格,调用函数时除外。例如:if (debug)
4.可以多使用空格(一行中有多个空格),如果这能够改善符号间的对齐。
圆括号或方括号内的代码两侧不要加空格,逗号后面除外。
(4)花括号
1.开始的{不能单独成行,结束的}必须单独成行,如:

if (is.null(ylim)) {
  ylim <- c(0, 0.06)
}

2.单独的一个语句应从新的一行开始。
(5)赋值
使用 <- 进行赋值,不用 = 赋值。

5.代码组织

如果是做项目或者多人合作,便于所有人都能快速阅读并理解他人的脚本,以下信息是必须有的:
a)版权声明注释
b)作者信息注释
c)文件说明注释(包括程序的用途,输入,输出)
d)source()library()语句说明
e)函数定义

6.注释

开发工程师应养成良好的注释习惯。
整行注释以 # 开头,加一个空格,如:# Create histogram of frequency
行内短注释需要在代码后面空两格,然后 # ,再加一个空格,如:

    hist(df$pctSpent,
    breaks = "scott",  # method for choosing number of buckets
    x     = "Frequency (count of campaignids)")

7.函数定义与调用

函数定义应首先列出无默认值的参数,然后再列出有默认值的参数。
在函数定义和调用时,允许每行写多个参数,一般只在赋值时才换行。如:

PredictCTR <- function(query, property, numDays,
    showPlot = TRUE)

在函数的定义行下方应当紧接一个注释区,包括:
-描述函数的作用
-描述函数的参数列表,用Args:对每个参数进行描述(包括数据类型)
-描述返回值,用Returns:
注释部分应尽可能详细充分,以便调用者在不阅读代码时就能使用该函数。

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 206,126评论 6 481
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 88,254评论 2 382
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 152,445评论 0 341
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 55,185评论 1 278
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 64,178评论 5 371
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,970评论 1 284
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,276评论 3 399
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,927评论 0 259
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 43,400评论 1 300
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,883评论 2 323
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,997评论 1 333
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,646评论 4 322
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,213评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,204评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,423评论 1 260
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 45,423评论 2 352
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,722评论 2 345

推荐阅读更多精彩内容

  • R 语言是一门主要用于统计计算和绘图的高级编程语言. 这份 R 语言编码风格指南旨在让我们的 R 代码更容易阅读、...
    萧子柔阅读 1,875评论 0 9
  • 本文档讲述了Java语言的编码规范,较之陈世忠先生《c++编码规范》的浩繁详尽,此文当属短小精悍了。而其中所列之各...
    蚁前阅读 897评论 0 51
  • ——by不是杀杀 为了使我们写的代码更容易阅读、避免过段时间再看自己写的代码就头疼,我们在写代码的时候应该注意一些...
    不会生信哟阅读 741评论 2 4
  • 编程的代码规范目的是使我们的R代码更容易阅读、分享和验证,下述是一些约定俗成的代码规范: 1.0 文件名 对于R ...
    LeoinUSA阅读 2,559评论 1 5
  • 介绍 本文档给出了Python代码的编码约定。 该样式指南会随着时间的流逝而发展,因为会发现其他约定,而过去的约定...
    Eazow阅读 469评论 0 0