[問題] 套件撰寫(undocumented data)

作者: Ian10 (Ian)   2016-08-02 03:58:50
[問題類型]:
程式諮詢
[軟體熟悉度]:
入門(寫過其他程式,只是對語法不熟悉)
[問題敘述]:
大家好:我想請問關於撰寫R套件的問題。
原本在撰寫套件時,我將全部有使用到的範例都寫成rd檔,但後來發現太過攏長,
希望改成內建資料不寫出他的詳細內容,只在主程式的Example中供使用者做範例。
於是,我直接將範例所使用到的rd檔從"man"的資料夾中刪除後,按下"check"後
會有一個warning 訊息: "checking for missing documentation entries"
告訴我這些資料要加上rd檔。但產生出來的pdf檔已幫我把全部資料的rd檔刪除
(符合我的要求)
我想請問如何解決這個warning?(有出現warning上傳到CRAN應該過不了吧?!)
還是說有用到的data就一定要寫rd檔?
在google搜尋找到兩個方法 (1.用到的data改放在主程式的資料夾裡("R")
2.同一個目錄再創一個資料夾,把data放進去)
兩個方法試完之後更慘,都從warning變error...
爬了一下文發現大家好像比較沒有這種問題QQ
第一次PO文如果有排版太難看的問題敬請見諒
謝謝大家
[環境敘述]:
R的版本:3.3.0
[關鍵字]:
package
作者: clickhere (It's time to go home.)   2016-08-02 09:33:00
把不想寫說明的函數都放在 man/zzz.Rd 就行了.或是從 NAMESPACE 中移除, 不要 expor 也可以不用寫.
作者: Ian10 (Ian)   2016-08-02 11:13:00
謝謝你的回覆,可是我不想寫說明的是data不是函數@@

Links booklink

Contact Us: admin [ a t ] ucptt.com