R包编写详细教程
最近在写一个R包,遇到了很多的坑,网上几乎没有一个教程能涵盖我遇到的所有问题,因此决定写一个教程。 当然,这不是说网上的教程都不好,网上那些教程都是写一个非常简单的示例,让你很快能够建立一个包,但是我们写包通常不是为了练练手,而是真的有开发的需求的,涉及到的点要比网上的示例和教程都多得多,动不动就会踩坑。所以决定把我踩到的坑都记录下来,方便自己也方便别人。 本文使用的环境是windows10系统Rstudio IDE,因此在写包的时候,需要先安装Rtools才能打包,如果要生成manual.pdf,同时还需要安装Latex的排版引擎,比如 MiKTeX ,本文不详述。还有如果你想写一个使用手册,最好使用RMarkdown,用它可以写出非常漂亮的使用手册,windows系统在Rstudio里可以通过install.packages('rmarkdown')直接安装,linux系统不知道如何安装可以看 Linux配置R markdown 。 本人是第一次写包,有些问题虽然各种查资料解决了,但是可能也没有真正的解决,欢迎各位在评论里批评指正。 写一个R包,大概要经过以下几个步骤: 1)准备一个R包,含有一些必需文件和文件夹。 2)准备R包需要用到的函数和测试数据,并写函数和测试数据的注释。 3)将函数封装成一个包。 4)写说明书。(非必须) 5)将R包上传到github,方便修改和维护。(非必须) 6)补充:遇到问题 以下介绍各个步骤的要点: 1、准备一个R包 在介绍这个之前,需要先了解一下 R包的结构。 我们可以通过Rstudio来获得一个基本的R包模板,模板里就是R包的结构和必需内容。通过Rstudio→File→New Project→New Directory→R package,填写R包名称和创建路径,获得一个名为“myPackage”的R包,里面有以下的文件或文件夹,是一个R包必须有的: myPackage(见图1) | ------ man文件夹:用于存放.Rd文件的文件夹,里面有一个示例文件hello.Rd。 | ------ R文件夹:用于存放R函数的文件夹,里面有一个示例文件hello.R。 | -...
评论
发表评论