在roxygen2 R包文档中插入标注表
是为了提供更丰富的文档信息和注释，以便于开发者和用户更好地理解和使用该R包。标注表是一种用于描述函数参数、返回值、示例代码等信息的注释格式。
在roxygen2中，可以使用特定的标记来插入标注表。以下是一些常用的标记和其含义：
@param：用于描述函数的参数。可以指定参数的名称、类型、默认值、描述等信息。例如：@param：用于描述函数的参数。可以指定参数的名称、类型、默认值、描述等信息。例如：- 推荐的腾讯云相关产品：无
@return：用于描述函数的返回值。可以指定返回值的类型、描述等信息。例如：@return：用于描述函数的返回值。可以指定返回值的类型、描述等信息。例如：- 推荐的腾讯云相关产品：无
@examples：用于提供函数的示例代码。可以展示函数的使用方法和预期输出。例如：@examples：用于提供函数的示例代码。可以展示函数的使用方法和预期输出。例如：- 推荐的腾讯云相关产品：无
@details：用于提供函数的详细说明。可以描述函数的实现原理、注意事项等信息。例如：@details：用于提供函数的详细说明。可以描述函数的实现原理、注意事项等信息。例如：- 推荐的腾讯云相关产品：无
@seealso：用于指定与当前函数相关的其他函数或文档。可以提供相关函数的名称和描述。例如：@seealso：用于指定与当前函数相关的其他函数或文档。可以提供相关函数的名称和描述。例如：- 推荐的腾讯云相关产品：无
通过在roxygen2 R包文档中插入标注表，可以提供清晰、详细的文档信息，帮助开发者和用户更好地理解和使用R包。这样可以提高代码的可读性、可维护性，并促进代码的重用和共享。
更多关于roxygen2的详细信息和用法，请参考腾讯云的相关文档：roxygen2 R包文档插入标注表。
相关·内容
1回答
R检查在使用@includeRmd时给出警告，例如使用Roxygene
r、r-package、roxygen2
我正在使用roxygen2编写一个R包作为文档。我使用@includeRmd标记来减少重复，这很好地在帮助文件、vignette和pkgdown网站上生成一致的文档。
我唯一的问题是，当我使用标记插入示例时，R CMD check给了我一个令人讨厌的警告。这是我的设置：
R/adder.R ...roxygen2块函数的源代码
#' Add three numbers
#'
#' @includeRmd includes/adder_description.Rmd description
#'
#' @param x First number to a
浏览 6提问于2022-01-21得票数 1
回答已采纳
1回答
从.R文件生成.Rd文件
r、roxygen2、rd
我知道roxygen2::roxygenise()或devtools::document() cane用于从.R文件生成.Rd文件。
例如，如果Test.R如下所示
#' Add together two numbers
#'
#' @param x A number
#' @param y A number
#' @return The sum of \code{x} and \code{y}
#' @examples
#' add(1, 1)
#' add(10, 1)
add <- function(x, y) {
浏览 1提问于2018-04-07得票数 2
回答已采纳
2回答
R帮助手册中能包含乳胶数学吗？
r、latex、roxygen2
我正在编写一个R包，并使用包Roxygen2为我的R函数编写帮助手册。我想知道的是，是否可以在手册页中使用latex作为数学方程？
例如，如果我有一个名为add2的函数，它执行以下操作：
add2 = function(x,y){
z = x+y
return(z)
}
使用Roxygen2文档，我有以下内容：
##' @include add2.R
{}
##' Compute the sum of x_1 and x_2
##'
##' Computes the sum of x_1 and x_2
##'
##'
浏览 13提问于2016-05-23得票数 18
回答已采纳
25回答
【开箱吧腾讯云】开发工具千千万，哪个最高效最好用？
腾讯云、产品、工具、开发、开发工具
开发工具千千万，哪个最高效最好用？
在关键时刻解决了你的卡点和痛点，欢迎你和我们一起分享你使用过的腾讯云宝藏工具！
点赞最高的前5名将获得猫王小王子花梨原木便携蓝牙音箱1个（截止时间：11月12日24:00）
另外在11月9日晚20:00-21:00
【开箱吧腾讯云】将迎来3位开发大神分享自身工具箱
快来腾讯云开发者视频号预约吧！更有超多双十一产品优惠等你！
图片
浏览 1737提问于2022-11-02
2回答
nginx双向配置里面的证书是SSL证书嘛？
官方文档、ios、nginx、SSL 证书
nginx双向配置里面的证书是SSL证书嘛？
我是移动APP，想添加双向认证。需要在安卓和IOS端也导入SSL证书嘛？还是只在服务端当中导入SSL证书即可完成NGINX双向认证配置？
另外，这个证书去哪个页面去申请？
标题：Nginx双向认证配置指南 - 云通信 - 产品文档 - 帮助与文档 - 腾讯云
地址：https://cloud.tencent.com/document/product/269/2714
浏览 424提问于2018-03-04
1回答
小程序·云开发中云函数支持python？
node.js、serverless、微信、小程序、小程序·云开发
云开发环境部署安装nodejs依赖，所以云函数还支持python语言吗？毕竟我看腾讯scf云函数中nodejs和python都是支持的
浏览 1764提问于2019-10-28
1回答
roxygen2 (5.0版)在函数内部发生#‘时错误地创建文档
r、roxygen2
考虑以下R函数定义，使用roxygen2 (version >=5.0)进行文档化
#' @title Test Bug
#' @author Daniel Egan
#' @param x
#' @return Nothing
#' @export
#' @examples
#' testFun(x)
testFun <- function(x){
#' Warning1'
return(TRUE)
}
当使用devtools:: document ()记录这个文件时，它会产生以下错误：
浏览 3提问于2015-11-04得票数 12
1回答
如何为R包创建具有动态输入的函数？
r、dynamic、r-package
我正在创建一个R包。我有一个函数，它需要来自用户的一些动态输入才能产生所需的输出。我目前使用readline()作为动态输入法。问题是我不知道如何让它在roxygen2 examples上工作，也不知道如何用testthat (或任何其他方法)正确地测试它。 如果有更好的方法获取用户输入，那也是很好的。 这是一个与我的函数具有相同问题的最小函数。 #' Dynamic Input Example
#'
#' @param input A number
#'
#' @return Console input times 2 minus 1
#'
浏览 21提问于2021-10-14得票数 0
回答已采纳
1回答
如何记录依赖外部包中的类的S4方法？
r、documentation、s4、roxygen2
我很难找到正确的方法来记录对外部包中的类进行操作的S4方法。免责声明:总的来说，我对S4和OOP非常陌生。
假设我有以下带有roxygen注释的泛型：
#' Converting an object to a polygon data.frame
#'
#' @param object some description
#' @param selection some description
#'
#' @details This function tries to parameterise polygons.
#' @return A
浏览 2提问于2019-08-06得票数 1
回答已采纳
3回答
将部分添加到R包的帮助/文档中
r、ggplot2、devtools、roxygen2、r-package
一些R包(例如，ggplot2、dplyr、devtools等)在他们的帮助/文档中有按字母顺序排列的标题部分，以及指向这些部分的链接栏(由下图中的红色箭头表示)。其他软件包(例如RcmdrMisc)没有。
如何将这些元素添加到may R包的帮助中？
我使用roxygen2编写文档。
浏览 2提问于2016-02-27得票数 8
5回答
名称空间不由roxygen2生成。跳过了。-混淆哈德利书
r、ggplot2、namespaces、package、devtools
我试图制作一个包，但是当我运行document()时，它会打印NAMESPACE not generated by roxygen2. Skipped.，我试图在我的函数中使用ggplot2,XML, R6包。我以下列方式进口：
#' @rdname visualization
#' @param hist_data A table of weather variables with PWS created by hist_data function
#' @param variable A character string of variable name
#'
浏览 26提问于2015-03-19得票数 40
回答已采纳
8回答
腾讯智能云为开发者带来哪些便利？
腾讯云、服务、开发、开发者、腾讯
腾讯云在云+未来峰会上推出了智能云。使得普通开发者能够快速上手进行开发。能够有效节省自身开发成本，我想知道究竟带来了哪些便利？有哪些服务极大提升了开发效率和用户体验？
浏览 871提问于2018-05-24
3回答
是否可以在roxygen2中使用非ASCII码字符编写包文档？
r、roxygen2、r-package
是否可以使用roxygen2中的非ASCII码字符(如？、ä、ö)在R中编写文档？我问这个问题是因为我正在用瑞典语编写一个带有内部函数的包。
我使用以下使用roxygen的代码来编写文档：
#' @param data data frame där variablen finns
#' @param x variabeln, måste vara en av typen character
这会导致非ASCII字符失真。我可以手动更改.Rd文件，但我不希望这样做。
浏览 2提问于2017-05-08得票数 12
1回答
roxygen2中的代码{链接{函数名}
r、roxygen2
这是我第一次写一个R包的经历.我使用roxygen2时遵循了这个链接中给出的说明
除了几件事外，每个人都很好。可以有一个简单的解决方案来解决这些问题，但我找不到线索，我做错了什么。我希望这个博客里的人能给我一个解决问题的办法。
第一个问题是关于roxygen2中的{\code\link{function-name}}：在.R脚本中，我插入了这一行：
#' @seealso \code{\link{s2a}}
在文档化(生成.Rd文件)之后，没有指向s2a的超链接，在文档中，s2a显示的是一个正常的文本，而不是超链接。导出(S2a)在命名空间中列出。还有什么地方我需要修改吗？
第二个问
浏览 1提问于2015-04-13得票数 7
1回答
R包文档(roxygen2) -示例部件-执行示例
r、documentation、package、roxygen2
我正在学习如何用roxygen2创建R包和更具体的文档。
我正在使用我在网上找到的一个非常简单的例子：
#' Add together two numbers.
#'
#' @param x A number.
#' @param y A number.
#' @return The sum of \code{x} and \code{y}.
#' @examples
#' add(1, 1)
#' add(10, 1)
#' @export
add <- function(x, y) {
x + y
}
但
浏览 14提问于2017-12-14得票数 2
回答已采纳
7回答
如何结合腾讯云开发微信小程序？
api、serverless、html5
目前，微信小程序越来越流行，而且功能越来越强大，在性能方面也越做越好。因为能够原生调用小程序提供的组件和 API ，小程序的开发快捷，使用方便，越来越多的产品会落地到微信小程序上。但传统的微信小程序开发，和普通的H5页面开发或者原生APP开发相比，只是改变了前端部分的开发方式，还是离不开厚重的后台开发。 现在的小程序，在后台服务方面，正在往 serverless 趋势方向发力。小程序提供了云厂商的无服务器函数 SCF，使得小程序无需搭建一个后台服务即可运行。如何结合腾讯云开发微信小程序？
浏览 3743提问于2018-09-28
1回答
在r脚本中记录函数
r、roxygen2
我在脚本中有一些函数，我想使用#roxygen2 2来记录这些函数，但是在线资源已经指向将函数记录在包中。我不想创建一个包，而是记录我的自定义函数。任何资源都是有帮助的。
我已经用#roxygen2 2语法编写了一些关于函数的详细信息，并试图记录它，但是它返回了一个“错误：package.dir必须包含一个描述文件”和“您在一个不是包根目录的目录中调用了roxygenize()吗？”
以下是#roxygen2 2音符
#'@title get_weather.
#'@description The function takes arguments of directory, c
浏览 4提问于2019-10-06得票数 5
回答已采纳
8回答
深度学习在腾讯云上有哪些应用？
深度学习
腾讯云有哪些相关产品呢？我想使用深度学习做一些事情，但是对我这种小白来说可能有点难，有没有相关的应用场景参考下，有教程的话最好！
浏览 1721提问于2018-09-07
扫码
添加站长 进交流群
领取专属 10元无门槛券
手把手带您无忧上云
相关资讯
热门标签
活动推荐
腾讯云开发者
