生信技巧每日分享day15-編寫R包

創(chuàng)建R包基本流程

1. 建立R包開發(fā)環(huán)境

  • 進(jìn)入Rstudio界面与纽,依次點(diǎn)擊File → New project → New Directory → R package,填寫好R包名字骗污,選擇好開發(fā)包的工作目錄(其它暫時(shí)都不用考慮);最后點(diǎn)擊Creat Project即可漂洋。

  • 完成后會(huì)自動(dòng)生成以下文件:

    (1)R 文件夾:用于存放R函數(shù)腳本的文件夾;里面有一個(gè)示例文件hello.R
    (2)man 文件夾:用于存放對(duì)應(yīng)上述R函數(shù)的說(shuō)明文檔Rd文件的文件夾;里面有一個(gè)示例文件hello.Rd声搁。
    (3)DESCRIPTION:關(guān)于R包的說(shuō)明文檔。
    (4)NAMESPACE:聲明R包導(dǎo)出以供外部使用的函數(shù)以及R包從其他包導(dǎo)入的外部函數(shù)捕发。

    其中疏旨,只有R函數(shù)腳本DESCRIPTION需要我們細(xì)心準(zhǔn)備外,其它可通過一些辦法自動(dòng)寫入扎酷、更新檐涝。

2. 編寫函數(shù)

  • 在R文件夾內(nèi)創(chuàng)建后綴名為.R的函數(shù)腳本,編寫自定義的函數(shù)

  • 把鼠標(biāo)放置在函數(shù)名上,按Ctrl+Alt+Shift+R組合快捷鍵為函數(shù)添加說(shuō)明文檔模板谁榜。

  • 最后使用一下代碼來(lái)生成幫助文檔(man文件夾里的Rd文件)

devtools::document()

3. 編寫DESCRIPTION文件

  • 手動(dòng)修改Version(版本號(hào))幅聘、Title(包的名字),Authors@R(作者名)窃植、Description(包的簡(jiǎn)要描述)

  • 使用下述函數(shù)帝蒿,自動(dòng)編寫License部分。如果沒有依賴到別的具有不同版權(quán)的第三方包的話巷怜,一般選擇最為廣泛使用的 MIT 即可

usethis::use_mit_license()
  • 補(bǔ)充依賴包的信息葛超。包括Depends、Imports延塑、Suggests绣张。

    1. Depends是最強(qiáng)的依賴,即在library的同時(shí)也library所依賴的包页畦,在使用被引函數(shù)的時(shí)候不用加::胖替,但可能會(huì)引起函數(shù)名沖突,慎用豫缨。
    2. Imports:如果只需要使用包中的某個(gè)函數(shù)独令,而不是整個(gè)包,那么引用類型就是Imports好芭。在函數(shù)腳本中燃箭,必須按照package::function,如dplyr::filter()的形式舍败。
    3. Suggests:如果沒有引用和依賴關(guān)系招狸,僅僅是在例子中使用了該包,那么我們僅僅是建議安裝這個(gè)包邻薯,這個(gè)時(shí)候的關(guān)系是“Suggests(建議)”裙戏。

    例如,在函數(shù)中用到了dplyr的filter()函數(shù)厕诡,則要使用以下代碼將dplyr設(shè)為依賴:

usethis::use_package(package, type = "Imports", min_version = NULL)
  • 單獨(dú)使用Imports累榜、Depends和Suggests引用的都是CRAN上的包,如果想引用Bioconductor上的包灵嫌,需要在前面加上biocViews:
image.png
  • R包本地安裝測(cè)試
devtools::install_local('path_to_Rpackage',force = T)

參考:

http://www.reibang.com/p/c0216f42edc5

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
  • 序言:七十年代末壹罚,一起剝皮案震驚了整個(gè)濱河市,隨后出現(xiàn)的幾起案子寿羞,更是在濱河造成了極大的恐慌猖凛,老刑警劉巖,帶你破解...
    沈念sama閱讀 206,126評(píng)論 6 481
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件绪穆,死亡現(xiàn)場(chǎng)離奇詭異辨泳,居然都是意外死亡虱岂,警方通過查閱死者的電腦和手機(jī),發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 88,254評(píng)論 2 382
  • 文/潘曉璐 我一進(jìn)店門漠吻,熙熙樓的掌柜王于貴愁眉苦臉地迎上來(lái)量瓜,“玉大人,你說(shuō)我怎么就攤上這事途乃。” “怎么了扔傅?”我有些...
    開封第一講書人閱讀 152,445評(píng)論 0 341
  • 文/不壞的土叔 我叫張陵耍共,是天一觀的道長(zhǎng)。 經(jīng)常有香客問我猎塞,道長(zhǎng)试读,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 55,185評(píng)論 1 278
  • 正文 為了忘掉前任荠耽,我火速辦了婚禮钩骇,結(jié)果婚禮上,老公的妹妹穿的比我還像新娘铝量。我一直安慰自己倘屹,他們只是感情好,可當(dāng)我...
    茶點(diǎn)故事閱讀 64,178評(píng)論 5 371
  • 文/花漫 我一把揭開白布慢叨。 她就那樣靜靜地躺著纽匙,像睡著了一般。 火紅的嫁衣襯著肌膚如雪拍谐。 梳的紋絲不亂的頭發(fā)上烛缔,一...
    開封第一講書人閱讀 48,970評(píng)論 1 284
  • 那天,我揣著相機(jī)與錄音轩拨,去河邊找鬼践瓷。 笑死,一個(gè)胖子當(dāng)著我的面吹牛亡蓉,可吹牛的內(nèi)容都是我干的晕翠。 我是一名探鬼主播,決...
    沈念sama閱讀 38,276評(píng)論 3 399
  • 文/蒼蘭香墨 我猛地睜開眼,長(zhǎng)吁一口氣:“原來(lái)是場(chǎng)噩夢(mèng)啊……” “哼!你這毒婦竟也來(lái)了绘雁?” 一聲冷哼從身側(cè)響起啄寡,我...
    開封第一講書人閱讀 36,927評(píng)論 0 259
  • 序言:老撾萬(wàn)榮一對(duì)情侶失蹤,失蹤者是張志新(化名)和其女友劉穎概漱,沒想到半個(gè)月后,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體,經(jīng)...
    沈念sama閱讀 43,400評(píng)論 1 300
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡简识,尸身上長(zhǎng)有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 35,883評(píng)論 2 323
  • 正文 我和宋清朗相戀三年,在試婚紗的時(shí)候發(fā)現(xiàn)自己被綠了。 大學(xué)時(shí)的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片七扰。...
    茶點(diǎn)故事閱讀 37,997評(píng)論 1 333
  • 序言:一個(gè)原本活蹦亂跳的男人離奇死亡奢赂,死狀恐怖,靈堂內(nèi)的尸體忽然破棺而出颈走,到底是詐尸還是另有隱情膳灶,我是刑警寧澤,帶...
    沈念sama閱讀 33,646評(píng)論 4 322
  • 正文 年R本政府宣布立由,位于F島的核電站轧钓,受9級(jí)特大地震影響,放射性物質(zhì)發(fā)生泄漏锐膜。R本人自食惡果不足惜毕箍,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 39,213評(píng)論 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望道盏。 院中可真熱鬧而柑,春花似錦、人聲如沸荷逞。這莊子的主人今日做“春日...
    開封第一講書人閱讀 30,204評(píng)論 0 19
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽(yáng)颅围。三九已至伟葫,卻和暖如春,著一層夾襖步出監(jiān)牢的瞬間院促,已是汗流浹背筏养。 一陣腳步聲響...
    開封第一講書人閱讀 31,423評(píng)論 1 260
  • 我被黑心中介騙來(lái)泰國(guó)打工, 沒想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留常拓,地道東北人渐溶。 一個(gè)月前我還...
    沈念sama閱讀 45,423評(píng)論 2 352
  • 正文 我出身青樓,卻偏偏與公主長(zhǎng)得像弄抬,于是被迫代替她去往敵國(guó)和親茎辐。 傳聞我的和親對(duì)象是個(gè)殘疾皇子,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 42,722評(píng)論 2 345

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