R语言代码规范

发布者： 书生刺客                      时间：2012年11月20日 14:45

1、一般性规则

避免使用attach
写 函数 是尽量少的使用stop()

定义S3和S4的对象不要混在一起使用

2、文件命名

以.r结束的文件，尽可能的增加信息在文件名里面，比如

Good:

predict_ad_revenue.R

Bad:

foo.R

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

# 注意，在R环境下，大小写是敏感的

变量：

Good:

avg.clicks

Bad:

avg_Clicks, avgClicks

函数名:

Good:

CalculateAvgClicks

Bad:

calculate_avg_clicks, calculateAvgClicks

4、字符间隔

这个可能是最快的，使代码外观变”漂亮”的规则了

Good:

tabPrior <- table(df[df$daysFromOpt < 0, "campaignid"])

Bad:

tabPrior<-table(df[df$daysFromOpt<0,"campaignid"])

这里包含了赋值、逻辑符号以及逗点分隔。

# 在R里面尽量少用 =

在函数里：

Good:

if (debug)

Bad:

if(debug)

5、代码组织

尤其是做项目的话，以下信息是必须有的：

版权声明
作者注释
文件说明，项目目的，输入和输出的说明
source() 和 library() 说明
函数定义
其他
6、注释

养成良好的注释习惯

单行注释以 # 开头，加一个空格
短注释需要在代码后面空两格，然后 # ，再加一个空格
最后再一次推荐使用Emacs+ESS。