R包开发-2.2:在RStudio中使用Rcpp制作R-Package(更新于2023.8.23)

目录

4-添加C++函数

5-编辑元数据

 6-启用Roxygen,执行文档化。

7-单元测试

8-在自己的计算机上安装R包:

9-程序发布

参考:


为什么要写这篇文章的更新日期?因为R语言发展很快,很多函数或者方式,现在可以使用,不代表之后的若干年之后,还可以用,可能那个时候有更方便且快捷的操作方式。

4-添加C++函数

有的时候,为了让R代码运行速度快一些,可能会借助一些编译语言,如C++。R是一门高级的、富有表现力的语言,但这事以速度为代价的,这就是为什么结合低级的编译语言(如C或者C++)可以有力地补充你的代码。虽然C和C++往往需要更多的代码行(和更仔细地思考)来解决同样地问题,但它们的速度可以比R快上几个数量级。

cpp = c plus plus = c++

c++函数函数可以直接在R中使用的接口为 Rcpp包(名字取得很好,R和C++)

usethis::use_rcpp("mean_rcpp")#生成一个mean_rcpp的c++文件

这个代码做了如下工作:

  • 创建一个src/目录以存放.cpp文件;
  • 在DESCRIPTION的LinkingTo和Imports域添加Rcpp;
  • 建立一个.gitignore文件,确保你不会无意中提交任何已编译的文件;
  • 在console中告诉你,需要你手动添加到报中的两个roxygen标签。(这条的具体细节在接下来的内容中会涉及到,这里不展开了。)

注意:C++代码都放在src/目录文件夹,R代码都放在R/目录文件夹,scr/目录这个文件夹是usethis::use_rcpp("c++函数名")自动生成。

 在https://github.com/coatless-r-n-d/rcpp-and-doparallel/tree/master/src 中找到我们想要生成的mena_rcpp.cpp文件,打开复制里面的内容到 我们当前打开的cpp文件。

 

 展示运行use_rcpp函数后console中的结果,√号表示这个函数完成的操作,●表示需要我们手动进行的操作。

> usethis::use_rcpp("mean_rcpp")
✔ Adding 'Rcpp' to LinkingTo field in DESCRIPTION
✔ Adding 'Rcpp' to Imports field in DESCRIPTION
• Copy and paste the following lines into 'R/ReproduceRcpp2doParallel-package.R':## usethis namespace: start#' @importFrom Rcpp sourceCpp## usethis namespace: endNULL[Copied to clipboard]
✔ Creating 'src/'
✔ Adding '*.o', '*.so', '*.dll' to 'src/.gitignore'
• Copy and paste the following lines into 'R/ReproduceRcpp2doParallel-package.R':## usethis namespace: start#' @useDynLib ReproduceRcpp2doParallel, .registration = TRUE## usethis namespace: endNULL[Copied to clipboard]
✔ Writing 'src/mean_rcpp.cpp'
• Modify 'src/mean_rcpp.cpp'

可以看到√号完成的工作内容在本文usethis::use_rcpp("mean_rcpp")函数介绍那已经介绍过了,我们重点来看下●的部分。一共有三个●,具体来说:

  1. • Copy and paste the following lines into 'R/ReproduceRcpp2doParallel-package.R':意思是将下面的行复制粘贴到R/ReproduceRcpp2doParallel-package.R文件。这个R文件是我们自己手动生成的,是"R包名字-package.R";
  2. • Copy and paste the following lines into 'R/ReproduceRcpp2doParallel-package.R':同上。
  3. Modify 'src/mean_rcpp.cpp' 修改mean_rcpp.cpp文件,意思是对创建的mean_rcpp.cpp中添加C++代码。

5-编辑元数据

每个包都必须有一个DESCRIPTION文件,它用来存放关于创建的R包的重要元数据。

打开DESCRIPTION文件,包名、编码等部分信息都是自己生成的,包括可编辑标题(单行文字)、版本号、作者、描述(一段文字)、网址等信息,导入、许可等信息更简易通过命令添加。

  • 版本号:通常是三位:大版本.小版本.补丁版本,按照数据值大小递进。
  • 依赖包:Imports下所列的包是必须存在的,因为构建的R包中使用了依赖包中的函数,当别人安装你的包的时候,也会自动安装这些包。推荐使用use_package("pkgname")的方式添加依赖包。
  • 选择许可
    • use_agpl3_license(),结果显示AGPL (>=3);
    • use_gpl3_license(),结果显示GPL(>=3).
    • use_gpl_license(version = 2)

  • LazyData为true,确保加载包时自动惰性加载(使用时才载入内存)内部数据集。

查看下面的目标,通过上述介绍的命令完成(1)添加依赖包,(2)选择许可(3)其他一些修改(如Title,作者等信息,这个不修改也可以,不影响我们复现这个R包)

 6-启用Roxygen,执行文档化。

  • Build tab -> More -> Configure Build Tools:
  • Check Generate documentation with Roxygen:
  •  Build--> More --->Document

7-单元测试

测试时开发R包的重要部分,可以确保代码更加稳健,能成功地实现相关的功能。

测试的一般原则是,设想函数可能遇到的各种情况下,是否都能得到预期的结果。策略之一是每当你遇到一个bug,就为它写一个测试,来检查函数是否能得到预期的结果。

虽然通过执行load_all()模拟加载包,可以在控制台做一些函数测试,但是更好的做法是采用testthat包提供的单元测试,这是一种正式的自动化测试。

具体操作如下:

先初始化包的单元测试:

use_testthat()

它将Suggests::testthat添加到DESCRIPTION,创建目录tests/testthat/,并添加脚本test/testthat.R。

打开或创建针对某函数的测试文件:

use_test("mean_parallel_compute")

测试文件是由若干个test_that()构成,第一个参数是对测试的描述,测试内容是大括号内的代码块,一般是比较函数返回值与期望值是否(近似)相等、是否复合类型等。

然后执行测试(若测试结果全为PASS,则表示通过测试):

test() 

如果单元测试没有问题,再执行R CMD check检测

check() 

 在控制台会输出潜在错误、警告、注意的具体反馈,我们希望三者都是0。

8-在自己的计算机上安装R包:

Build --> Install package

注:如果已经安装了这个包,但是发现还需要对这个包做些修改,可以在R的安装地,lib文件夹中找到这个包,删掉即可,这样可以重新进行包的安装,否则在安装包的时候,会提示存在Error,这个提示是清楚的,清楚的写明了这个R包存在lib的位置。 

9-程序发布

开发完的R包,如果愿意开源给其他人使用,有几个发布平台供选择:CRAN、GitHub。

  • CRAN是大家比较熟悉的,由R Core的小组维护,审查很严格;
  • GitHub是通过devtools包维护的一个发布平台,适合个人发布,无审查。

由于CRAN平台有各种审查,不允许随便发布,那么我们就先把程序发布到GitHub上面,等功能完善后,再申请提交到CRAN。把项目上传到GitHub的操作,和R语言没有什么关系。

操作步骤为:Git--> Staged--> Commit --> Push(下面会展示具体操作细节),将包的相关文件推送到GitHub远程仓库,换句话说,将包发布到GitHub,从而别人可以从GitHub上通过devtools包可以安装和使用你的R包。

 具体步骤:

  • 点击Git

  •  单击“暂存”复选框以暂存要推送到GitHub的文件,然后单击“提交”。

  •  将打开一个新窗口,它将反映您要提交到GitHub存储库的文件。您也可以在“提交消息”文本框中编写提交消息,然后单击“提交”按钮。(不要选中“修改以前的提交”框——这只会导致灾难)值得注意的是:下图的Commit message要填写内容,这个例子中填写的是“First commit”,这个在下面第二张图可以看到。如果不再commit message中填写内容,则会终止提交,告知你因为没有commit message。提交到GitHub成功后会看到在每个文件后面看到commit message.

  •  单击“提交”按钮后,您将看到以下屏幕。单击“关闭”按钮关闭窗口。

  •  在GitHub上提交文件后,您会发现右上角窗口为空。这意味着您已将文件提交到存储库。现在,在最后一步中,您需要单击“推送”以推送存储库中的文件。

  •  最后,您将看到一个包含Git Push消息的新窗口。如果一切正确,那么不会有任何错误,您的文件已成功推送到GitHub存储库中。

  •  您还可以通过访问特定存储库在GitHub上进行交叉检查。

 通过这种方式,您可以使用RStudio Server轻松暂存、提交和推送到GitHub。

参考:

Setup an R-Package with Rcpp in RStudio | Sebastian Hanß

《R语言编程》(张敬信,2023年2月,人民邮电出版社)(这本书写的很全面且细致,没有多余的废话。)

《R包开发》(Hadley, 2016年8月,人民邮电出版社)(这本书出版的时间比较长,书中有部分函数发生了调整。)

R Packages (2e) (r-pkgs.org) (这是是R包开发的第二版,较第一版有了些内容的调整和删减,下面截图是这本书的内容,左侧是目录,右侧是正文。值得花时间阅读。)

《R的极客理想:高级开发篇》(张丹,2015年7月,机工社)

Introduction to Computational and Data Sciences (这本书也超棒!很细节。本文第9节参考的是这本书的第4.9节)

RStudio制作包含Rcpp代码的R包_rcpp package_Kanny广小隶的博客-CSDN博客

注:写CSDN一定要少用Ctrl+Z呀,有时候撤回的不是一步。

R package-2ed
这是R package 2ed的截图

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处:http://www.rhkb.cn/news/107566.html

如若内容造成侵权/违法违规/事实不符,请联系长河编程网进行投诉反馈email:809451989@qq.com,一经查实,立即删除!

相关文章

js中作用域的理解?

1.作用域 作用域,即变量(变量作用域又称上下文)和函数生效(能被访问)的区域或集合 换句话说,作用域决定了代码区块中变量和其他资源的可见性 举个例子 function myFunction() {let inVariable "函数内部变量"; } myFunction();//要先执行这…

NPM 管理组织包

目录 1、关于组织范围和包 1.1 管理无作用域的包 2、使用组织设置配置npm客户端 2.1 配置您的npm客户端以使用您组织的范围 为所有新包设置组织范围 为单个包设置组织范围 2.2 将默认包可见性更改为public 将单个包的包可见性设置为public 将所有包的包可见性设置为pu…

人脸识别平台批量导入绑定设备的一种方法

因为原先平台绑定设备是通过一个界面进行人工选择绑定或一个人一个人绑定设备。如下: 但有时候需要在几千个里选择出几百个,那这种方式就不大现实了,需要另外一种方法。 目前相到可以通过导入批量数据进行绑定的方式。 一、前端 主要是显示…

opencv进阶18-基于opencv 决策树导论

1. 什么是决策树? 决策树是最早的机器学习算法之一,起源于对人类某些决策过程 的模仿,属于监督学习算法。 决策树的优点是易于理解,有些决策树既可以做分类,也可以做回归。在排名前十的数据挖掘算法中有两种是决策树[1…

软件设计师学习笔记6-存储系统

1.层次化存储体系 1.1层次化存储结构 局部性原理是层次化存储结构的支持 时空局部性:刚被访问的内容,立即又被访问(eg: 循环体 ) 空间局部性:刚被访问的内容,临近的空间很快被访问(eg:数组) 1.2层次化存储结构的分类 DRAM&…

统计学补充概念-17-线性决策边界

概念 线性决策边界是一个用于分类问题的线性超平面,可以将不同类别的样本分开。在二维空间中,线性决策边界是一条直线,将两个不同类别的样本分隔开来。对于更高维的数据,决策边界可能是一个超平面。 线性决策边界的一般形式可以表…

使用信号处理算法过滤加速度数据并将其转换为速度和位移研究(Matlab代码实现)

💥💥💞💞欢迎来到本博客❤️❤️💥💥 🏆博主优势:🌞🌞🌞博客内容尽量做到思维缜密,逻辑清晰,为了方便读者。 ⛳️座右铭&a…

postgresql常用函数-数学函数

postgresql常用函数 简介数学函数算术运算符绝对值取整函数乘方与开方指数与对数整数商和余数弧度与角度常量 π符号函数生成随机数 简介 函数(function)是一些预定义好的代码模块,可以将输入进行计算和处理,最终输出一个 结果值…

【Git】学习总结

【Git】学习总结 【一】安装【二】Git克隆项目代码【1】idea下载git项目【2】创建新的分支【3】新建的分支推送到远程【4】合并最新代码到主分支【5】切换分支 【三】提交本地项目到远程🚀1. 配置 Git🚀2. 创建项目远程仓库🚀3. 初始化本地仓…

详细手机代理IP配置

嗨,亲爱的朋友们!作为一家代理产品供应商,我知道有很多小伙伴在使用手机进行网络爬虫和数据采集时,常常会遇到一些IP限制的问题。别担心!今天我要给大家分享一下手机IP代理的设置方法,让你们轻松应对这些限…

C语言暑假刷题冲刺篇——day5

目录 一、选择题 二、编程题 🎈个人主页:库库的里昂 🎐CSDN新晋作者 🎉欢迎 👍点赞✍评论⭐收藏✨收录专栏:C语言每日一练✨相关专栏:代码小游戏、C语言初阶、C语言进阶🤝希望作者…

飞天使-k8s基础组件分析-控制器

文章目录 控制器含义解释pod的标签与注释ReplicaControllerReplicaSetDeploymentsDaemonSetJobCronjob参考文档 控制器含义解释 空调遥控器知道吧ReplicationController: ReplicationController确保在任何时候都运行指定数量的pod副本。换句话说,一个ReplicationCo…

实战项目 在线学院springcloud调用篇3(nacos,feging,hystrix,gateway)

一 springcloud与springboot的关系 1.1 关系 1.2 版本关系 1.3 list转json串 public class Test {public static void main(String[] args) {List<String> dataListnew ArrayList<String>();dataList.add("12");dataList.add("45");dataLi…

guassian filter and bilateral filter

在用CRF 后处理segmentation的时候有一项 d.addPairwiseGaussian(sxy(5, 5), compat3, kerneldcrf.DIAG_KERNEL,normalizationdcrf.NORMALIZE_SYMMETRIC)# This adds the color-dependent term, i.e. features are (x,y,r,g,b).d.addPairwiseBilateral(sxy(5, 5), srgb(13, 13…

代码随想录算法训练营之JAVA|第三十九天|474. 一和零

今天是第39天刷leetcode&#xff0c;立个flag&#xff0c;打卡60天。 算法挑战链接 474. 一和零https://leetcode.cn/problems/ones-and-zeroes/ 第一想法 题目理解&#xff1a;找到符合条件的子集&#xff0c;这又是一个组合的问题。 看到这个题目的时候&#xff0c;我好像…

量化QAT QLoRA GPTQ

模型量化的思路可以分为PTQ&#xff08;Post-Training Quantization&#xff0c;训练后量化&#xff09;和QAT&#xff08;Quantization Aware Training&#xff0c;在量化过程中进行梯度反传更新权重&#xff0c;例如QLoRA&#xff09;&#xff0c;GPTQ是一种PTQ的思路。 QAT…

Java将PDF文件转为Word文档

Java将PDF文件转为Word文档 一、创建Springboot Maven项目 二、导入依赖信息 <repositories><repository><id>com.e-iceblue</id><url>https://repo.e-iceblue.cn/repository/maven-public/</url></repository></repositories&g…

单片机电子元器件-数码管

数码管分类 共阳 把所有数码管的阳极接到一起形成公共阳极COM 数码管 共阳极COM 接到 5V 电源 共阴 把所有数码管的阴极接到一起形成公共阴极COM 数码管 共阴极COM 接到 地 GND 上 八段 数码管 和 七段数码管&#xff0c; 多了一个 小数点 DP 数码管显示原理 一个数码管如…

FPGA GTX全网最细讲解,aurora 8b/10b协议,HDMI视频传输,提供2套工程源码和技术支持

目录 1、前言免责声明 2、我这里已有的 GT 高速接口解决方案3、GTX 全网最细解读GTX 基本结构GTX 发送和接收处理流程GTX 的参考时钟GTX 发送接口GTX 接收接口GTX IP核调用和使用 4、设计思路框架视频源选择IT6802解码芯片配置及采集动态彩条视频数据组包GTX aurora 8b/10b数据…

springboot+mp完成简单案例

目录 1.框架搭建 2.前端搭建 3.后端编写 需求&#xff1a;完成简单的连表条件查询以及添加即可 1.框架搭建 1.创建springboot项目 2.相关依赖 <!--web依赖--><dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boo…