首页
学习
活动
专区
工具
TVP
发布
精选内容/技术社群/优惠产品,尽在小程序
立即前往

把函数包起来就是一个R包 - 完整开发指南

.Rd是Rmarkdown文件文档时候可以直接在函数上面以标准格式形式写注释,再使用roxygen2包来生成.Rd文件 打开fbind.R文件,然后点击Code>Insert roxygen skeleton...Depends attach包;而Imports只load包;一般情况下只需Imports里面列出需要包,写函数时候使用::来获取需要函数;另外Imports或者Depends里面的包在安装时候如果没有安装会自动安装...: https://github.com/yihui/knitr/issues 对象文档化 man/ 标准方法是man/文件夹下写.Rd文件,再渲染成HTML和PDF;但是可以使用roxygen2可以将特定格式注释转化成....Rd文件roxygen2除了生成.Rd文件外还可以更改NAMESPACE和DESVRIPTION中Collate字段 基本流程有4步: 将roxygen格式注释添加到.R文件中 使用devtools...image-20200916144852749 Roxygen 注释 Roxygen注释以#'开头,并且函数前面;所有函数前面的roxygen行叫做一个block,每一行超过80个字符 block

2.1K32
您找到你想要的搜索结果了吗?
是的
没有找到

R语言里面如何高效开发R包

对我来说,比较新知识点可能是一些小技巧,这里借花献佛给大家。 高效开发R包 什么情况下我们需要开发R包呢 开发R包(也称为R库)是一种有效方法,可以用来组织、共享和重用你R代码。...每个函数通常都会有自己R文件。 man目录:这个目录包含了包帮助文件,这些文件是用Rd格式写,每个函数或数据集都应该有一个对应帮助文件。...你需要为你包选择一个名称,并选择一个位置来保存包。 添加函数:你可以R目录中添加你函数。每个函数通常都会有自己R文件。 添加文档:你可以为你函数添加文档。...RStudio中,你可以使用Roxygen注释来添加文档。..." -> "Generate documentation with Roxygen"来生成文档

19620

编写专属 MSBuild C# 代码生成器:保存文件时自动实时生成你代码

而本文是在此基础上更进一步,可以让生成代码变成实时;更准确说,是保存文件时即生成代码,而无需完整编译一次项目。...一天,头像全白昵称空格“wuweilai”童鞋问我为什么 GRPC NuGet 包能自动 .proto 文件保存时更新生成代码,怎么才能做到像它那样。...我们即将实现是:保存 Test.txt 文件时,会立即执行我们编译流程,这样,我们便能基于 Test.txt 来实时生成一些代码。...最简单自动生成代码逻辑 现在,我们打开项目 csproj 文件(双击项目名称即可打开编辑这个文件): 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19...如果你想复制到你项目里,记得去掉行首所有 + 号。 等你复制到项目里之后,试着 Test.txt 文件里面随便写点什么,然后保存

34010

R包简单教程

data/: 包中附带数据文件。 R包工作流程 为了有效利用R包,一般遵循以下工作流程: 指定名字,创建R包,并编写DESCRIPTION文件,对R包进行简单描述。...如有必要,data/中添加数据文件R/中编写对应功能R文件 编写好R文件后,生成R文档tests/中编写R文件测试文件vignettes/中编写项目的说明文档。...R文档 对于每个R函数,需要编写R文档,包含R函数功能、调用、使用方法等。...编写完成后,执行devtools::document()即可生成文档,生成文档\man目录下,此例中生成了hello_country.Rd文件。 重新建立包,执行?...hello_country即可预览生成R文档。 测试R文件 每个R函数编写完成后,需要对其进行测试,测试文件放在\test文件夹下。

1.8K100

科学软件十条简单编程原则

一天结束时,人们(包括您自己)需要能够阅读和理解您源代码。好变量和函数名称可以极大地提高可读性,尽管它们不能完全替代注释。虽然你代码没有评论情况下可能会很明显,但其他读者可能不会那么幸运。...一个好经验法则是假设README中包含信息将是用户阅读唯一文档。因此,您自述文件应包括如何安装和配置软件,何处查找完整文档何处发布许可证,如何测试以确保功能以及确认。...规则6:版本控制您文档 首先,您应该将文档与其他文件一起保存在Git存储库中。这使您可以项目历史中任何位置查看文档。...RSphinx(sphinx-doc.org),perldoc,Javadoc和Roxygen(https://github.com/klutometis/roxygen)等软件可以生成文档,甚至可以阅读您注释并使用它们生成详细...此外,重要是要说明生成错误时软件状态,特别是如果运行需要很长时间或默认情况下保存日志。

86420

TidyFriday 如何编写一个自动获取和展示疫情数据 R 包?

查看创建项目文件夹 我们可以从桌面上找到这个文件夹: ?...还是先创建一个包文档: usethis::use_package_doc() 使用下面的语句 R 文件夹里面创建并打开 Hello.R 文件: usethis::edit_file("R/Hello.R...然后关于 Git 部分操作就可以在这个表单里完成了,我不就不说这部分了,因为很多小伙伴可能还没用过 GitHub,所以我们还是回到 R 包编写上。...编写 ncov 包 DESCRIPTION 文件 使用下面的命令把该包依赖 R 包写入 DESCRIPTION 文件 Imports 字段下: for(pkg in c("jsonlite",...License 字段是声明该包许可证,这里我使用是 MIT 许可 + 文件许可证,这个文件内容是: YEAR: 2020 COPYRIGHT HOLDER: Zhenxing Cheng 这是符合

1K10

编写你自己R包

创建函数 可以手动创建函数: library("devtools") use_r("hd") 自动R目录创建了名为hd.R文件,这这里面就可以写函数所有信息 前面写函数注释信息,然后接着写函数内容...is.null(names(obj))) names(res) = names(obj)[idx_x] } return(res) } 我编写了一个方便查看一二维数据函数...,可以这里注释信息包括以下部分: Description 这部分具体描述函数功能,没有特定标签,最开始书写,可换行 title 一般即为函数名 param param_name...将此函数导出至环境中,使用户可以使用,写该标签的话用户不能使用,但是可以该R脚本内调用(private??)...检查、生成Rmd文档 check() devtools::document() 这一步骤先检查上一步书写语法是否有误以及是否有遗漏等其他错,之后将注释信息和函数转换为Rmd文档

48720

AI 技术讲座精选:如何创建 R 包并将其发布 CRAN GitHub 上?

将包提交至像 CRAN 之类主要仓库时需通过严格质量测试。 不断进行更新。如果包维护人员 CRAN 上更新活动活跃,他包就会被遗弃。 4....你还须确保你已安装以下几个包:quantmod、xts、roxygen2 和 devtools。 5. 从零开始编写第一个包 现在让我们开始创建一个简单包。... R studio 打开 DESCRIPTION 文件,编辑内容以最好地匹配对包描述。然后保存。这就是我在编写这个包时步骤。 ?...Suggests 包含运行例子或生成文档时可能需要库。这个包最后描述文件如下所示: ? 进入 R 文件夹,你会发现已生成 hello.R script。...必须在 export 字段下 hello.R 文件编写这个‘stock_predict’函数。

1.8K50

Deep learning基于theanokeras学习笔记(0)-keras常用代码

保存Keras模型 这里推荐使用pickle或cPickle来保存Keras模型。 1....一般使用model.save(filepath)将Keras模型和权重保存在一个HDF5文件中,该文件将包含: 模型结构,以便重构该模型 模型权重 训练配置(损失函数,优化器等) 优化器状态,以便于从上次训练中断地方开始...= model.to_yaml() 当然,你也可以从保存json文件或yaml文件中载入模型: # model reconstruction from JSON: from keras.models...[3].output]) layer_output = get_3rd_layer_output([X])[0] 当然,我们也可以直接编写Theano和TensorFlow函数来完成这件事 get_3rd_layer_output...训练数据训练时会被随机洗乱吗? 如果model.fitshuffle参数为真,训练数据就会被随机洗乱。设置时默认为真。训练数据会在每个epoch训练中都重新洗乱一次。

88610

麻省理工三位教授教你一步步创建自己R程序包(附完整教程下载)

默认目录应该是空,可以通过Is()命令来查看 - 你应该能够清楚看见回复为(0) 2. R文件中可以为你程序编写代码。你可以创建一个包含所有函数文件,或者是为每个文件都创建单独文件。...根据Rstudio版本,当你创建R安装包或者R文档时,帮助文件会自动生成。 如果“man”文件夹中已经包含.Rd文件,打开每个文件,添加一个标题然后保存.(如果不是,请见步骤7)。...但是为了编译你安装包,你需要在每个.Rd文件下添加一个标题。 7. 如果你”man”文件夹是空,那么你需要为每个函数手动创建一个.Rd文件。...编辑你文件要包含标题域(再次强调,你可以选择现在编辑或者是稍后编辑,如果标题域是空,那么你安装包将无法编译)。保存”man”文件夹中每一个.Rd文件。...9.返回并为每个函数编辑其记录文件(帮助文件)。打开每一个.Rd文件,为安装包添加一段简短描述。如果可以的话,包含至少一个例子。接着,重载你安装包,R控制台上彻底检验你文件

1.8K30

干货 | MIT手把手教你一步步创建自己R程序包

1、首先打开一个新R文件,确保你默认目录是清楚通过rm进行输入(list=ls())。查看Is(),确保它是空(你应该能够清楚看见(0))。 2、R文件中可以为你程序编写代码。...“man”文件中将包含了文件中函数所有帮助文件。根据Rstudio版本,当你创建R安装包或者R文档时,帮助文件会自动生成。...如果“man”文件夹中已经包含.Rd文件,打开每个文件,添加一个标题然后保存.(如果不是,请见步骤7)。你可以返回并在稍后编辑这些内容。...保存“man”文件夹中每一个.Rd文件。 注意:如果你需要在你安装包里添加更多函数,那么你需要重复以上步骤。即使是在你一开始创建安装包和RStudio自动生成R记录文件时候。...打开每一个.Rd文件,为安装包添加一段简短描述。如果可以的话,至少包含一个实例。接着,重载你安装包,R控制台上彻底检验你文件

88010

学会这 11 条,你离 Git 大神就不远了!

使用命令行代替图形化界面 使用命令行来操作,简洁且效率高 提交应该尽可能表述提交修改内容 区分 subject 和 body 内容,使用空行隔开 subject 一般超过 50 个字符 body 每一行长度控制...使用 merge 操作 - Python 中 Requests 库使用 支持使用 merge 开发者,他们认为仓库提交历史就是记录实际发生过什么,它是针对于历史一个文档,本身其实是有价值,我们不应该随意修改...但是最后,提交 PR 之前,一般情况下,我们是应该整理下这些提交记录。有些 commit 需要合并起来,或者需要将其删除掉,等等。...而其钩子脚本对应内容,都是使用 Shell 语法进行编写。...此时,我们需要保存上个分支工作状态,我们修改完成线上 bug 之后,再继续工作。

33240

巧用R语言实现各种常用数据输入与输出

R语言中数据输入需要设置数据读取路径,一般将数据文件放到工作目录下,这样直接就可以通过read.table等读取数据文档(不许要设置路径)。...常用参数说明如下: (1)file:file是一个带分隔符ASCII文本文件。 ①绝对路径或者相对路径。一定要注意,R语言中\是转义符,所以路径分隔符需要写成"\\"或者“/”。...(2)header:一个表示文件是否第一行包含了变量逻辑型变量。 如果header设置为TRUE,则要求第一行要比数据列数量少一列。 (3)sep分开数据分隔符。...file: 一个字符串命名文件编写而打开一个连接。 " "表示输出到控制台。 append: 逻辑。只有当file是一个字符串才相关。...如果一个数值向量,其元素为引用索引。在这两种情况下,行和列名报价,如果他们被写入。如果FALSE,并没有被引用。 sep: 字段分隔符字符串。每一行x中值都被这个字符串分隔开。

7.4K42

学会这 11 条,你离 Git 大神就不远了!

使用命令行代替图形化界面 使用命令行来操作,简洁且效率高 提交应该尽可能表述提交修改内容 区分 subject 和 body 内容,使用空行隔开 subject 一般超过 50 个字符 body 每一行长度控制...使用 merge 操作 - Python 中 Requests 库使用 支持使用 merge 开发者,他们认为仓库提交历史就是记录实际发生过什么,它是针对于历史一个文档,本身其实是有价值,我们不应该随意修改...但是最后,提交 PR 之前,一般情况下,我们是应该整理下这些提交记录。有些commit需要合并起来,或者需要将其删除掉,等等。...而其钩子脚本对应内容,都是使用 Shell 语法进行编写。...此时,我们需要保存上个分支工作状态,我们修改完成线上 bug 之后,再继续工作。

58410

为什么要用conda来安装一个R包

正常情况下,我们R包都是依附于R语言环境,常见情况是个人电脑Rstudio这样界面软件安装。...比如最近有小伙伴问到了popsicleR这个包,它还在GitHub上面,官网是:https://github.com/bicciatolab/popsicleR 它也有很多依赖包,而且官网文档很清楚...另外就是,大家安装它时候,它没办法很好自动解决它自己依赖问题,所以官网给了其系列依赖包独立安装方式。...ggplotify","RANN","umap", "celldex","curl","httr","lattice","session","shinythemes","usethis","rcmdcheck", "roxygen2...官网文档给了一个 https://github.com/bicciatolab/popsicleR/blob/main/docs/popsicleR.yml, 可以看到内容如下所示: yaml格式文件

83820

11个Git实用技巧记录!

使用命令行代替图形化界面 使用命令行来操作,简洁且效率高 提交应该尽可能表述提交修改内容 区分 subject 和 body 内容,使用空行隔开 subject 一般超过 50 个字符 body 每一行长度控制...使用 merge 操作 - Python 中 Requests 库使用 支持使用 merge 开发者,他们认为仓库提交历史就是记录实际发生过什么,它是针对于历史一个文档,本身其实是有价值,我们不应该随意修改...但是最后,提交 PR 之前,一般情况下,我们是应该整理下这些提交记录。有些 commit 需要合并起来,或者需要将其删除掉,等等。...而其钩子脚本对应内容,都是使用 Shell 语法进行编写。...此时,我们需要保存上个分支工作状态,我们修改完成线上 bug 之后,再继续工作。

21310

Git 实用技巧记录,看这篇你就明白了!

每一行长度控制 72 个字符 subject 结尾不需要使用句号或者点号结尾 body 用来详细解释此次提交具体做了什么 使用 .gitignore 文件来排除无用文件: 可使用模板文件,然后根据项目实际进行修改...使用 merge 操作 - Python 中 Requests 库使用 支持使用 merge 开发者,他们认为仓库提交历史就是记录实际发生过什么,它是针对于历史一个文档,本身其实是有价值,我们不应该随意修改...但是最后,提交 PR 之前,一般情况下,我们是应该整理下这些提交记录。有些 commit 需要合并起来,或者需要将其删除掉,等等。...而其钩子脚本对应内容,都是使用 Shell 语法进行编写。...此时,我们需要保存上个分支工作状态,我们修改完成线上 bug 之后,再继续工作。

42920

数据科学、机器学习IDE概览

RStudio 集成了 Git 和 SVN 支持,同时支持编写 HTML、PDF、Word 文档、幻灯片、交互式图形(基于 Shiny 和 ggvis)。... Visual Studio 下,数据科学家能够以便利结构组织和管理相关文件,并使用 R 代码、R 文档、R Markdown、SQL 请求、保存过程等模板。...RTVS 可以绑定本地和远程工作区,这让开发者可以本地基于较小数据集编写 R 代码,然后很方便地更强大云计算机中更大数据集上运行代码。...开发者可以通过 R Markdown 文档分享数据结果,markdown 代码段可以使用集成 R 代码。 RTVS 为 R 提供了完整 REPL 体验,可以交互窗口中直接运行源文件代码。...绘图是 R 一个重要部分。为了方便用 R 绘图,RTVS 支持多个独立绘图窗口,每个具有独立历史,并支持在窗口间移动图形。图形可以保存为图像或 PDF 文件,或者复制到剪贴板。

3.5K30
领券