利用RStudio及roxygen2套件建立屬於自己的R套件

全文

(1)生物統計. 利用RStudio及roxygen2套件建立屬於自己的R套件農試所作物組楊滿霞. 一、前言. 二、安裝必要軟體. R 是一個結合統計分析與繪圖功能. 安裝軟體R及Rtools可在網站https://. 的免費自由軟體，主要用於統計分析及. www.r-project.org/ 下載 R 及 Rtools，進. 圖表繪製，最早由 Ross Ihaka 與 Robert. 入網頁點選 download R 後，選擇 CRAN. Gentleman(1966) 所開發，因此稱為R。目. M i r r o r s 的國家名稱（即您的所在位. 前開發的核心團隊是由一群熱心專業的. 置），台灣有 3 個選擇網址，擇一點選. 統計資訊學者所組成，其網址為：http://. 後，可依據本機端的作業系統下載 R. www.r-project.org ，該網站中可見到 R. 有多種不同作業系統版本，例如 Unix、 Windows 及 MacOS，及有關 R 的操作手. 冊與常見問題等學習資源。R 本身也是一種程式語言，如發展新的分析方法，可自行撰寫程式來做資料分析，亦有研究員將最新發表的統計方法寫成 R 套件（Packages，R 使用者撰寫的功能）搭配發表期刊方式公開分享，R的功能可以透過安裝套件增強，本文將以 Windows 為例，說明如何利用RStudio及 roxygen2 套件，建立自己的R套件並上傳到R CRAN 分享。. （base）及Rtools，將軟體下載儲存至電腦中即可接續軟體安裝作業。安裝軟體 RStudio可到https://www.rstudio.com/下載 RStudio，進入網頁選擇RStudio Desktop Open Source License，再依據本機端的. 作業系統下載RStudio。完成以上軟體下載及安裝後，開啟 RStudio安裝 roxygen2 套件後即可開始建立新套件，首先點選 RStudio 左上方工作列 File，接著依序出. 現的畫面點選New Project, New Directory 及 New Project，接著在Project name欄位中填上欲建立之套件名稱，本文此例為 MyProject，再點選Create Project，則完成. 建立新套件(如圖一)。. 三、roxygen2套件功能完成建立新套件後，可使用roxygen2 套件功能來編輯自己的 R 套件內容，完. 作者：楊滿霞助理研究員連絡電話：04-23317128. 26. 農業試驗所技術服務季刊．2019年9月．119期. 成下列6步驟即可完成屬於自己的套件編輯作業：.

(2) 生物統計. (1) 點選右上方工作表 Tools. 的 Project Options 選項後，點選左列表Build Tools選項再勾選enerate documentation with Roxygen，接. 著出現的對話框點選 O K ，完成 roxygen2套件之設定（如圖二）。 ( 2 ). 點開右下角視窗. D E SC R I P T I O N 檔案，填寫欲建. 立套件的基本資訊，包含套件名稱、版本、作者、維護者（含電郵），套件基本描述，可使用的 R 版本（一般為 3 以上）等， DESCRIPTION 檔案內黑字為說明. 文字，閱讀後刪除再填入相對應資. 圖一、利用RStudio建立自己的套件。. 訊後存檔。 (3) 編輯 R 程式檔案：打開右. 下角視窗R資料夾，內有預設程式 hello.R，本文使用此預設程式做. 說明，首先刪除R程式以上的資訊（即以 # 開頭的部分），再加入對此程式的說明，例如標題名稱、描述、參數、例子等，最後加上 #' @export 後儲存（如圖三），此檔. 案為R程式給使用者閱讀之說明檔的內容，請謹慎填寫，詳細編輯方式可參考https://cran.r-project.org/ web/packages/roxygen2/vignettes/ rd.html內容。 (4). 刪除man資料夾與. NAMESPACE檔案，此兩檔案內容. 不需自己手動編輯，點選右上角 Build之Document選項可由roxygen2. 自動產生，開啟自動產生的man資. 圖二、roxygen2套件之設定步驟。. 農業試驗所技術服務季刊．2019年9月．119期. 27.

(3) 生物統計. 料夾與NAMESPACE檔案查看內容是否正確（如圖四）。 (5) 最後點選右上角Check，檢查. 套件程式或設定內容是否有錯誤，確認無錯誤或警告訊息，恭喜您的套件已經完成編輯。 (6) 完成編輯的套件可點選. 上方工作列Build的Build Source Package 和 Build Binary Package 選. 項，前者產生 MyPackage_0.1.0.tar. gz 可提供上傳 R CRAN，後者產生 MyPackage_0.1.0.zip可提供給朋友使. 用，完成壓縮檔案之彈跳視窗會顯示套件存放的位置，預設位置為C槽文圖三、編輯DESCRIPTION及R程式檔案。. 件夾（如圖五）。. 四、R套件的傳遞如有R程式上課或分享的需求，最便利的方法，就是將 R 程式建立為R套件儲存成壓縮檔方便套件的傳遞，以 M y P a c k a g e 例子說明，首先打開 R 軟體之 R 主控視窗點選上方「程式套件」的 Install package(s) from local files選項，再選. 擇MyPackage_0.1.0.zip位置後開啟，主控視窗將出現成功安裝MyPackage 套件的訊息，完成安裝後輸入指令 library(MyPackage)呼叫MyPackage套. 件，再輸入hello()即成功出現「Hello, world!」訊息（如圖六）。. 建立之R套件亦可上傳到 R CRAN給全球R使用者下載圖四、利用roxygen2套件產生man資料夾與 NAMESPACE檔案。. 28. 農業試驗所技術服務季刊．2019年9月．119期. 使用，其上傳步驟如下使用 MyPackage_0.1.0.tar.gz說明：.

(4) 生物統計. 圖五、初步檢查套件內容及產生套件壓縮檔。. 圖六、R套件的傳遞分享步驟。. 農業試驗所技術服務季刊．2019年9月．119期. 29.

(5) 生物統計. (5) 完成3步驟上傳到R CRAN 後，系統會對您上傳的套. 件做檢測，檢測結果會電郵給您。 (6) 如無大問題再請您等待5. 個工作天做人工檢測，工作檢測後無問題會再寄出通知信告知您的 R 套件已可在 R CRAN 中下載了。. 五、結語建立及上傳R套件的過程簡單，但要順利完成可能不容易，建立 R 套件時需排解檢查 R 套件時出現的錯誤及警告訊息，待完成檢查作業上傳 R CRAN時，進一步系統及人工進行更嚴格的套件檢查作業，可能又有其他待修正訊息需要進行套件的微調，如果無法了解待修正訊息含圖七、R套件上傳R CRAN步驟。. (1) 在 R 首頁 https://www.r-project. org/，左方列表點選CRAN，再選擇CRAN Mirrors國家（即所在位置），台灣有3個. 網址位置擇一點選即可。 (2) 在Submitting to CRAN標題下方，. 點選web form。 (3) 出現3步驟上傳CRAN的畫. 面，首先填寫姓名、聯絡電郵及上傳 MyPackage_0.1.0.tar.gz套件，電郵請正確. 填寫，隨後系統將自動寄出確認信（如圖七）。 (4) 該確認信內有一確認網址，請點. 擊該網址即完成確認步驟。. 30. 農業試驗所技術服務季刊．2019年9月．119期. 意，最好的方式是複製訊息貼到 GOOGLE 上，即出現其他亦被此訊息困. 住的R使用者討論串可供參考，完成修正後，再重新上傳更新後的套件即可，約等待5個工作天，如經過 R團隊的審核通過，會再電郵通知所編寫的R套件已經上傳到R CRAN供全球R使用者下載使用。本文簡單介紹建立及上傳R套件的步驟，如想了解 R 套件的結構及完整功能，除了官方參考手冊 https://cran. r-project.org/doc/manuals/r-release/R-exts. html 資訊外，亦可參考Hadley Wickham. 所寫的線上免費閱讀的電子書R package (http://r-pkgs.had.co.nz/)。.

(6)