从.Rd文件生成.R文件

时间:2018-04-07 13:04:22

标签: r roxygen2 rd

我知道roxygen2::roxygenise()devtools::document()用于从 .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) {
  x + y
}

然后roxygen2::roxygenise()devtools::document()的输出将为

% Generated by roxygen2 (3.2.0): do not edit by hand
\name{add}
\alias{add}
\title{Add together two numbers}
\usage{
add(x, y)
}
\arguments{
  \item{x}{A number}

  \item{y}{A number}
}
\value{
The sum of \code{x} and \code{y}
}
\description{
Add together two numbers
}
\examples{
add(1, 1)
add(10, 1)
}

然而,我感兴趣反之亦然。我确实有 .Rd ,我想将其转换为 .R 文件。有任何想法!

1 个答案:

答案 0 :(得分:1)

Rd2roxygen包将为您执行此操作:

  

它可以将Rd文件解析为列表,创建'roxygen'文档并相应地更新原始R脚本(例如包含函数定义的脚本)。

这是on CRAN;作者的文档页面是here

转换您要运行的单个Rd文件

library(Rd2roxygen)
create_roxygen(parse_file("my_rd_file.Rd"))

将结果作为字符向量返回(writeLines()以将其保存到文件中)。