[问题] 套件撰写(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