R語言編碼規(guī)范

1.一般性規(guī)則

(1)避免使用attach疟暖。
(2)寫函數(shù)時(shí)盡量少的使用stop()绝骚。
(3)定義S3和S4的對(duì)象不要混在一起使用贪嫂。

2.文件命名

(1)文件名應(yīng)以.R結(jié)尾寺庄,文件名本身要有意義,如:predict_ad_revenue.R撩荣。
(2)R代碼就放在.R文件中铣揉,而R數(shù)據(jù)文件則放在.RData文件中。

3.變量名和函數(shù)命名規(guī)則

注意餐曹,在R環(huán)境下逛拱,大小寫是敏感的。
1.變量名應(yīng)都用小寫字母台猴,單詞間用.分隔朽合。
2.函數(shù)名的每個(gè)單詞用大寫字母開頭,不用.連接饱狂。
3.常數(shù)項(xiàng)與函數(shù)命名規(guī)則一致曹步,但以小寫k開頭。
以下舉例說明:
變量:avg.clicks休讳;
函數(shù)名:CalculateAvgClicks用動(dòng)詞命名函數(shù)讲婚;
常數(shù)項(xiàng):kConstantName

4.R語句

(1)單行長(zhǎng)度
每行最長(zhǎng)80個(gè)字符俊柔。
(2)縮進(jìn)
使用兩個(gè)空格來縮進(jìn)代碼筹麸,不要使用制表符或混合使用二者活合。
(3)空格
1.在所有二次運(yùn)算符(=,+物赶,-白指,<-,等)的兩側(cè)加上空格酵紫。
2.不可在逗號(hào)前加空格告嘲,逗號(hào)后必須加空格。
例如:tabPrior <- table(df[df$daysFromOpt < 0, "campaignid"])
3.括號(hào)左邊用空格奖地,調(diào)用函數(shù)時(shí)除外橄唬。例如:if (debug)
4.可以多使用空格(一行中有多個(gè)空格)鹉动,如果這能夠改善符號(hào)間的對(duì)齊轧坎。
圓括號(hào)或方括號(hào)內(nèi)的代碼兩側(cè)不要加空格,逗號(hào)后面除外泽示。
(4)花括號(hào)
1.開始的{不能單獨(dú)成行缸血,結(jié)束的}必須單獨(dú)成行,如:

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

2.單獨(dú)的一個(gè)語句應(yīng)從新的一行開始械筛。
(5)賦值
使用 <- 進(jìn)行賦值捎泻,不用 = 賦值。

5.代碼組織

如果是做項(xiàng)目或者多人合作埋哟,便于所有人都能快速閱讀并理解他人的腳本笆豁,以下信息是必須有的:
a)版權(quán)聲明注釋
b)作者信息注釋
c)文件說明注釋(包括程序的用途,輸入赤赊,輸出)
d)source()library()語句說明
e)函數(shù)定義

6.注釋

開發(fā)工程師應(yīng)養(yǎng)成良好的注釋習(xí)慣闯狱。
整行注釋以 # 開頭,加一個(gè)空格抛计,如:# Create histogram of frequency哄孤。
行內(nèi)短注釋需要在代碼后面空兩格,然后 # 吹截,再加一個(gè)空格瘦陈,如:

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

7.函數(shù)定義與調(diào)用

函數(shù)定義應(yīng)首先列出無默認(rèn)值的參數(shù),然后再列出有默認(rèn)值的參數(shù)波俄。
在函數(shù)定義和調(diào)用時(shí)晨逝,允許每行寫多個(gè)參數(shù),一般只在賦值時(shí)才換行懦铺。如:

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

在函數(shù)的定義行下方應(yīng)當(dāng)緊接一個(gè)注釋區(qū)捉貌,包括:
-描述函數(shù)的作用
-描述函數(shù)的參數(shù)列表,用Args:對(duì)每個(gè)參數(shù)進(jìn)行描述(包括數(shù)據(jù)類型)
-描述返回值,用Returns:
注釋部分應(yīng)盡可能詳細(xì)充分昏翰,以便調(diào)用者在不閱讀代碼時(shí)就能使用該函數(shù)苍匆。

?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
  • 序言:七十年代末,一起剝皮案震驚了整個(gè)濱河市棚菊,隨后出現(xiàn)的幾起案子,更是在濱河造成了極大的恐慌叔汁,老刑警劉巖统求,帶你破解...
    沈念sama閱讀 218,682評(píng)論 6 507
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件,死亡現(xiàn)場(chǎng)離奇詭異据块,居然都是意外死亡码邻,警方通過查閱死者的電腦和手機(jī),發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 93,277評(píng)論 3 395
  • 文/潘曉璐 我一進(jìn)店門另假,熙熙樓的掌柜王于貴愁眉苦臉地迎上來像屋,“玉大人,你說我怎么就攤上這事边篮〖狠海” “怎么了?”我有些...
    開封第一講書人閱讀 165,083評(píng)論 0 355
  • 文/不壞的土叔 我叫張陵戈轿,是天一觀的道長(zhǎng)凌受。 經(jīng)常有香客問我,道長(zhǎng)思杯,這世上最難降的妖魔是什么胜蛉? 我笑而不...
    開封第一講書人閱讀 58,763評(píng)論 1 295
  • 正文 為了忘掉前任,我火速辦了婚禮色乾,結(jié)果婚禮上誊册,老公的妹妹穿的比我還像新娘。我一直安慰自己暖璧,他們只是感情好案怯,可當(dāng)我...
    茶點(diǎn)故事閱讀 67,785評(píng)論 6 392
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著漆撞,像睡著了一般殴泰。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發(fā)上浮驳,一...
    開封第一講書人閱讀 51,624評(píng)論 1 305
  • 那天悍汛,我揣著相機(jī)與錄音,去河邊找鬼至会。 笑死离咐,一個(gè)胖子當(dāng)著我的面吹牛,可吹牛的內(nèi)容都是我干的。 我是一名探鬼主播宵蛀,決...
    沈念sama閱讀 40,358評(píng)論 3 418
  • 文/蒼蘭香墨 我猛地睜開眼昆著,長(zhǎng)吁一口氣:“原來是場(chǎng)噩夢(mèng)啊……” “哼!你這毒婦竟也來了术陶?” 一聲冷哼從身側(cè)響起凑懂,我...
    開封第一講書人閱讀 39,261評(píng)論 0 276
  • 序言:老撾萬榮一對(duì)情侶失蹤,失蹤者是張志新(化名)和其女友劉穎梧宫,沒想到半個(gè)月后接谨,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體,經(jīng)...
    沈念sama閱讀 45,722評(píng)論 1 315
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡塘匣,尸身上長(zhǎng)有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 37,900評(píng)論 3 336
  • 正文 我和宋清朗相戀三年脓豪,在試婚紗的時(shí)候發(fā)現(xiàn)自己被綠了。 大學(xué)時(shí)的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片忌卤。...
    茶點(diǎn)故事閱讀 40,030評(píng)論 1 350
  • 序言:一個(gè)原本活蹦亂跳的男人離奇死亡扫夜,死狀恐怖,靈堂內(nèi)的尸體忽然破棺而出驰徊,到底是詐尸還是另有隱情笤闯,我是刑警寧澤,帶...
    沈念sama閱讀 35,737評(píng)論 5 346
  • 正文 年R本政府宣布辣垒,位于F島的核電站望侈,受9級(jí)特大地震影響,放射性物質(zhì)發(fā)生泄漏勋桶。R本人自食惡果不足惜脱衙,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 41,360評(píng)論 3 330
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望例驹。 院中可真熱鬧捐韩,春花似錦、人聲如沸鹃锈。這莊子的主人今日做“春日...
    開封第一講書人閱讀 31,941評(píng)論 0 22
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽屎债。三九已至仅政,卻和暖如春,著一層夾襖步出監(jiān)牢的瞬間盆驹,已是汗流浹背圆丹。 一陣腳步聲響...
    開封第一講書人閱讀 33,057評(píng)論 1 270
  • 我被黑心中介騙來泰國(guó)打工, 沒想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留躯喇,地道東北人辫封。 一個(gè)月前我還...
    沈念sama閱讀 48,237評(píng)論 3 371
  • 正文 我出身青樓硝枉,卻偏偏與公主長(zhǎng)得像,于是被迫代替她去往敵國(guó)和親倦微。 傳聞我的和親對(duì)象是個(gè)殘疾皇子妻味,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 44,976評(píng)論 2 355

推薦閱讀更多精彩內(nèi)容

  • R 語言是一門主要用于統(tǒng)計(jì)計(jì)算和繪圖的高級(jí)編程語言. 這份 R 語言編碼風(fēng)格指南旨在讓我們的 R 代碼更容易閱讀、...
    蕭子柔閱讀 1,919評(píng)論 0 9
  • 本文檔講述了Java語言的編碼規(guī)范欣福,較之陳世忠先生《c++編碼規(guī)范》的浩繁詳盡责球,此文當(dāng)屬短小精悍了。而其中所列之各...
    蟻前閱讀 912評(píng)論 0 51
  • ——by不是殺殺 為了使我們寫的代碼更容易閱讀劣欢、避免過段時(shí)間再看自己寫的代碼就頭疼棕诵,我們?cè)趯懘a的時(shí)候應(yīng)該注意一些...
    不會(huì)生信喲閱讀 751評(píng)論 2 4
  • 編程的代碼規(guī)范目的是使我們的R代碼更容易閱讀、分享和驗(yàn)證凿将,下述是一些約定俗成的代碼規(guī)范: 1.0 文件名 對(duì)于R ...
    LeoinUSA閱讀 2,598評(píng)論 1 5
  • 介紹 本文檔給出了Python代碼的編碼約定。 該樣式指南會(huì)隨著時(shí)間的流逝而發(fā)展价脾,因?yàn)闀?huì)發(fā)現(xiàn)其他約定牧抵,而過去的約定...
    Eazow閱讀 482評(píng)論 0 0